NodeOPCUA API Documentation
    Preparing search index...

    Interface FileOptions

    interface FileOptions {
        filename: string;
        fileSystem?: AbstractFs;
        maxChunkSize?: number;
        maxOpenFilesPerServer?: number;
        maxOpenFilesPerSession?: number;
        maxSize?: number;
        mimeType?: string;
        nodeId?: NodeIdLike;
        refreshFileContentFunc?: () => Promise<void>;
        writable?: boolean;
    }
    Index
    filename: string

    the filaname of the physical file which is managed by the OPCUA filetpye

    fileSystem?: AbstractFs
    maxChunkSize?: number

    the maximum number of bytes that can be read from the file in a single read call

    • if not specified or 0, we assume Int32 limit
    maxOpenFilesPerServer?: number

    the maximum number of file handles that all the Sessions can hold at the same time, for all the files of the address space. When the Sessions already hold this number of handles, Open on this file returns BadResourceUnavailable. Keep this value below the file descriptor limit of the process, with a margin for sockets.

    maxOpenFilesPerSession?: number

    the maximum number of file handles that one Session can hold at the same time, for all the files of the address space. When the Session already holds this number of handles, Open on this file returns BadResourceUnavailable.

    maxSize?: number

    the maximum allowed size of the physical file, in bytes. A Write that would go past this size returns BadOutOfRange and writes nothing.

    mimeType?: string

    an optional mimeType

    nodeId?: NodeIdLike
    refreshFileContentFunc?: () => Promise<void>
    writable?: boolean

    whether the file can be opened for writing. The Writable Property exposes this value. When false, Open with the Write bit returns BadNotWritable. Read access does not change.

    • if not specified, the file is writable

    UserWritable also takes the user access rights into account: a user without the Call permission on the Write Method cannot open the file for writing (BadUserAccessDenied).