Hierarchy

  • System

Methods

  • Close releases any resources used for the related filesystem.

    Returns void

  • Copy copies the file stored at srcKey to dstKey.

    If dstKey file already exists, it is overwritten.

    Parameters

    • srcKey: string
    • dstKey: string

    Returns void

  • CreateThumb creates a new thumb image for the file at originalKey location. The new thumb file is stored at thumbKey location.

    thumbSize is in the format:

    • 0xH (eg. 0x100) - resize to H height preserving the aspect ratio
    • Wx0 (eg. 300x0) - resize to W width preserving the aspect ratio
    • WxH (eg. 300x100) - resize and crop to WxH viewbox (from center)
    • WxHt (eg. 300x100t) - resize and crop to WxH viewbox (from top)
    • WxHb (eg. 300x100b) - resize and crop to WxH viewbox (from bottom)
    • WxHf (eg. 300x100f) - fit inside a WxH viewbox (without cropping)

    Parameters

    • originalKey: string
    • thumbKey: string
    • thumbSize: string

    Returns void

  • Delete deletes stored file at fileKey location.

    Parameters

    • fileKey: string

    Returns void

  • DeletePrefix deletes everything starting with the specified prefix.

    The prefix could be subpath (ex. "/a/b/") or filename prefix (ex. "/a/b/file_").

    Parameters

    • prefix: string

    Returns Error[]

  • Exists checks if file with fileKey path exists or not.

    Parameters

    • fileKey: string

    Returns boolean

  • GetFile returns a file content reader for the given fileKey.

    NB! Make sure to call Close() after you are done working with it.

    Parameters

    • fileKey: string

    Returns blob.Reader

  • List returns a flat list with info for all files under the specified prefix.

    Parameters

    • prefix: string

    Returns ListObject[]

  • Serve serves the file at fileKey location to an HTTP response.

    If the download query parameter is used the file will be always served for download no matter of its type (aka. with "Content-Disposition: attachment").

    Parameters

    Returns void

  • SetContext assigns the specified context to the current filesystem.

    Parameters

    Returns void

  • Upload writes content into the fileKey location.

    Parameters

    • content: string | number[]
    • fileKey: string

    Returns void

  • UploadFile uploads the provided multipart file to the fileKey location.

    Parameters

    Returns void

  • UploadMultipart uploads the provided multipart file to the fileKey location.

    Parameters

    Returns void

Generated using TypeDoc