Options
Menu

@s3-publish/provider-fs Module

Index

Classes

Interfaces

Constructor Options Type aliases

Other Type aliases

Constructor Options Type aliases

FSProviderOptions

FSProviderOptions: { bridge?: FSProviderBridge; delegate?: FSProviderDelegate; ignores?: FilePredicate; root: string }

Type declaration

Other Type aliases

FSCopyParams

FSCopyParams: { dirMode?: undefined | number; flags?: undefined | number; fromPath: string; toPath: string }

Type declaration

  • Optional dirMode?: undefined | number

    The file mode for created directories.

    remarks

    The parent path is recursively created if it does not exist.

    default

    0o777

  • Optional flags?: undefined | number

    Integer that specifies the behavior of the copy operation.

    default

    0

    see

    fs.copyFile

  • fromPath: string
  • toPath: string

FSDeleteParams

FSDeleteParams: { filePath: string }

Type declaration

  • filePath: string

FSGetParams

FSGetParams: { filePath: string; readStreamOptions?: StreamOptions }

Type declaration

FSPutParams

FSPutParams: { body?: Readable; dirMode?: undefined | number; filePath: string; writeStreamOptions?: StreamOptions }

Type declaration

  • Optional body?: Readable
    see

    Readable

  • Optional dirMode?: undefined | number

    The file mode for created directories.

    remarks

    The parent path is recursively created if it does not exist.

    default

    0o777

  • filePath: string
  • Optional writeStreamOptions?: StreamOptions

Stats

Stats: { isDirectory: () => boolean; mtime: Date; size: number }

Type declaration

  • isDirectory: () => boolean
      • (): boolean

      • Returns boolean

  • mtime: Date

    Last modified date

  • size: number

    Size in bytes

StreamOptions

StreamOptions: { encoding?: "ascii" | "utf8" | "utf-8" | "utf16le" | "ucs2" | "ucs-2" | "base64" | "latin1" | "binary" | "hex" | undefined; flags?: undefined | string; mode?: undefined | number }

Type declaration

Generated using TypeDoc