Type Alias IFileStorageAdapter

Type declaration

• add:function

  • add(
        context: IReadableContext,
        key: string,
        content: WritableFileAdapterContent,
    ): Promise<boolean>

  • Creates new file at key if it doesn't already exist. Fails if key already exists (use put for upsert or update for existing files). Content is loaded entirely in memory - use addStream for large files.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      The file identifier/path where file will be created
    • content: WritableFileAdapterContent

      File content with HTTP headers configuration

    Returns Promise<boolean>

    True if file was created, false if key already exists

• addStream:function

  • addStream(
        context: IReadableContext,
        key: string,
        stream: WritableFileAdapterStream,
    ): Promise<boolean>

  • Creates new file at key using streaming content if it doesn't already exist. Fails if key already exists (use putStream for upsert or updateStream for existing files). Content is streamed - efficient for large files or continuous data sources.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      The file identifier/path where file will be created
    • stream: WritableFileAdapterStream

      File content stream with HTTP headers configuration

    Returns Promise<boolean>

    True if file was created, false if key already exists

• copy:function

  • copy(
        context: IReadableContext,
        source: string,
        destination: string,
    ): Promise<FileWriteEnum>

  • Copies source file to destination path if destination doesn't exist. Destination is left unchanged if source not found or destination already exists.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • source: string

      Source file identifier/path to copy from
    • destination: string

      Destination file identifier/path to copy to

    Returns Promise<FileWriteEnum>

    FileWriteEnum indicating: SUCCESS (copied), NOT_FOUND (source missing), or KEY_EXISTS (destination exists)

• copyAndReplace:function

  • copyAndReplace(
        context: IReadableContext,
        source: string,
        destination: string,
    ): Promise<boolean>

  • Copies source file to destination path, overwriting destination if it exists. Returns false if source doesn't exist; destination remains unchanged.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • source: string

      Source file identifier/path to copy from
    • destination: string

      Destination file identifier/path to copy to (will be overwritten)

    Returns Promise<boolean>

    True if source was found and copied, false if source doesn't exist

• exists:function

  • exists(context: IReadableContext, key: string): Promise<boolean>

  • Checks whether a file exists at the given key.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      The file identifier/path to check

    Returns Promise<boolean>

    True if file exists, false otherwise

• getBytes:function

  • getBytes(
        context: IReadableContext,
        key: string,
    ): Promise<null | Uint8Array<ArrayBufferLike>>

  • Retrieves complete file content as a byte array. The entire file must fit in memory - use getStream for large files. Returns null if the file does not exist.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      The file identifier/path

    Returns Promise<null | Uint8Array<ArrayBufferLike>>

    Complete file bytes as Uint8Array, or null if file not found

• getMetaData:function

  • getMetaData(
        context: IReadableContext,
        key: string,
    ): Promise<null | FileAdapterMetadata>

  • Retrieves file metadata (ETag, content type, size, modification date). Returns null if the file does not exist. Useful for cache validation and file information endpoints.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      The file identifier/path

    Returns Promise<null | FileAdapterMetadata>

    File metadata object, or null if file not found

• getStream:function

  • getStream(
        context: IReadableContext,
        key: string,
    ): Promise<null | FileAdapterStream>

  • Retrieves file content as an async stream of byte chunks. Memory-efficient for large files - content is streamed rather than loaded entirely. Returns null if the file does not exist.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      The file identifier/path

    Returns Promise<null | FileAdapterStream>

    Async iterable of Uint8Array chunks, or null if file not found

• move:function

  • move(
        context: IReadableContext,
        source: string,
        destination: string,
    ): Promise<FileWriteEnum>

  • Moves (renames) source file to destination path if destination doesn't exist. Destination is left unchanged if source not found or destination already exists. Effectively deletes the source file after successful copy.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • source: string

      Source file identifier/path to move from
    • destination: string

      Destination file identifier/path to move to

    Returns Promise<FileWriteEnum>

    FileWriteEnum indicating: SUCCESS (moved), NOT_FOUND (source missing), or KEY_EXISTS (destination exists)

• moveAndReplace:function

  • moveAndReplace(
        context: IReadableContext,
        source: string,
        destination: string,
    ): Promise<boolean>

  • Moves (renames) source file to destination path, overwriting destination if it exists. Returns false if source doesn't exist; destination remains unchanged. Effectively deletes the source file after successful copy.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • source: string

      Source file identifier/path to move from
    • destination: string

      Destination file identifier/path to move to (will be overwritten)

    Returns Promise<boolean>

    True if source was found and moved, false if source doesn't exist

• put:function

  • put(
        context: IReadableContext,
        key: string,
        content: WritableFileAdapterContent,
    ): Promise<boolean>

  • Creates or overwrites file (upsert) at key with content. Always succeeds: creates file if doesn't exist, overwrites if exists. Content is loaded entirely in memory - use putStream for large files.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      The file identifier/path to create or update
    • content: WritableFileAdapterContent

      File content with HTTP headers configuration

    Returns Promise<boolean>

    True if file was updated (already existed), false if newly created

• putStream:function

  • putStream(
        context: IReadableContext,
        key: string,
        stream: WritableFileAdapterStream,
    ): Promise<boolean>

  • Creates or overwrites file (upsert) at key using streaming content. Always succeeds: creates file if doesn't exist, overwrites if exists. Content is streamed - efficient for large files or continuous data sources.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      The file identifier/path to create or update
    • stream: WritableFileAdapterStream

      File content stream with HTTP headers configuration

    Returns Promise<boolean>

    True if file was updated (already existed), false if newly created

• removeByPrefix:function

  • removeByPrefix(context: IReadableContext, prefix: string): Promise<void>

  • Removes all files whose keys start with the given prefix. Useful for batch deletion by directory or namespace. Silently succeeds if no keys match the prefix.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • prefix: string

      Key prefix to match (e.g., "uploads/2024-01/" for all January uploads)

    Returns Promise<void>

    Void (always succeeds)

• removeMany:function

  • removeMany(context: IReadableContext, keys: string[]): Promise<boolean>

  • Removes multiple specific files by key.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • keys: string[]

      Array of file identifiers/paths to delete

    Returns Promise<boolean>

    True if at least one key was deleted, false if no keys were found

• update:function

  • update(
        context: IReadableContext,
        key: string,
        content: WritableFileAdapterContent,
    ): Promise<boolean>

  • Updates existing file at key with new content. Fails if key doesn't exist (use put for upsert or add for new files). Content is loaded entirely in memory - use updateStream for large files.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      The file identifier/path to update
    • content: WritableFileAdapterContent

      New file content with HTTP headers configuration

    Returns Promise<boolean>

    True if file was updated, false if key doesn't exist

• updateStream:function

  • updateStream(
        context: IReadableContext,
        key: string,
        stream: WritableFileAdapterStream,
    ): Promise<boolean>

  • Updates existing file at key using streaming content. Fails if key doesn't exist (use putStream for upsert or addStream for new files). Content is streamed - efficient for large files or continuous data sources.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      The file identifier/path to update
    • stream: WritableFileAdapterStream

      New file content stream with HTTP headers configuration

    Returns Promise<boolean>

    True if file was updated, false if key doesn't exist