Class FileStorageBackend

constructor

• new FileStorageBackend(basePath: string): FileStorageBackend

  Creates a new file storage backend bound to the specified base path. The basic file storage backend does not support recursive operations into subfolders and only operates on files contained within the specified base path. All directory entries are ignored.

  Parameters

  • basePath: string

    The base path to use for all file operations.

  Returns FileStorageBackend

  Throws

  IllegalArgumentError if the base path is null, undefined, or empty.

  Throws

  StorageBackendError if the base path does not exist or is not a directory.

ReadonlybasePath

delete

• delete(key: string): Promise<void>

  Deletes the persisted data from the storage backend. Not all storage backends support deletion.

  Parameters

  • key: string

    The key to use to delete the data from the storage backend. The key is implementation specific and might be a file path, a config map name, or an environment variable prefix.

  Returns Promise<void>

isSupported

• isSupported(op: StorageOperation): boolean

  Checks if the storage backend supports the given operation. Implementations must provide a valid definition which responds appropriately for the requested operation.

  Parameters

  • op: StorageOperation

    The desired storage operation to check.

  Returns boolean

  True if the operation is supported, false otherwise.

list

• list(): Promise<string[]>

  List all keys in the storage backend. Not all storage backends support listing keys.

  Returns Promise<string[]>

  A list of keys in the storage backend.

readBytes

• readBytes(key: string): Promise<Buffer<ArrayBufferLike>>

  Reads the persisted data from the storage backend and marshals it into bytes.

  Parameters

  • key: string

    The key to use to read the data from the storage backend. The key is implementation specific and might be a file path, a config map name, or an environment variable prefix.

  Returns Promise<Buffer<ArrayBufferLike>>

  The persisted data represented as a byte array.

writeBytes

• writeBytes(key: string, data: Buffer): Promise<void>

  Write the configuration data to the storage backend by marshalling the bytes into the underlying persistent data format.

  Parameters

  • key: string

    The key to use to write the data to the storage backend. The key is implementation specific and might be a file path, a config map name, or an environment variable prefix.
  • data: Buffer

    The persistent data represented as a byte array.

  Returns Promise<void>