Interface IObjectStoreConnector

Represents a connector for interacting with an object store.

interface IObjectStoreConnector {
    calculateSize(path: string): Promise<number>;
    createFolder(path: string): Promise<IFolderDescriptor>;
    createWritableStream(path: string, options?: IFileOptions): Promise<IWritableStream>;
    deleteObject(path: string): Promise<ObjectKind>;
    get(path: string, options?: IFileOptions): Promise<IFile>;
    list(path: string, recursive: boolean): Promise<ObjectDescriptor[]>;
    moveObject(path: string, newPath: string): Promise<ObjectKind>;
    writeFile(file: File, path?: string, options?: IFileOptions): Promise<IFileDescriptor>;
}

Index

Methods

calculateSize createFolder createWritableStream deleteObject get list moveObject writeFile

Methods

calculateSize

calculateSize(path): Promise<number>
Calculates the size of an object.
Parameters
- path: string
  The path to the object.
Returns Promise<number>
A promise that resolves with the size of the object.

createFolder

createFolder(path): Promise<IFolderDescriptor>
Creates a folder.
Parameters
- path: string
  The path to the folder.
Returns Promise<IFolderDescriptor>
A promise that resolves with the folder descriptor.

createWritableStream

createWritableStream(path, options?): Promise<IWritableStream>
Creates a writable stream for a file.
Parameters
- path: string
  The path to the file.
- Optionaloptions: IFileOptions
  The options for creating the writable stream.
Returns Promise<IWritableStream>
A promise that resolves with an IWritableStream.

deleteObject

deleteObject(path): Promise<ObjectKind>
Deletes an object.
Parameters
- path: string
  The path to the object.
Returns Promise<ObjectKind>
A promise that resolves with the object kind.

get

get(path, options?): Promise<IFile>
Gets a file.
Parameters
- path: string
  The path to the file.
- Optionaloptions: IFileOptions
  The options for writing the file.
Returns Promise<IFile>
A promise that resolves with the file.

list

list(path, recursive): Promise<ObjectDescriptor[]>
Lists the objects in a folder.
Parameters
- path: string
  The path to the folder.
- recursive: boolean
  Whether to list the objects recursively.
Returns Promise<ObjectDescriptor[]>
A promise that resolves with an array of object descriptors.

moveObject

moveObject(path, newPath): Promise<ObjectKind>
Moves an object.
Parameters
- path: string
  The path to the object.
- newPath: string
  The path to move the object to.
Returns Promise<ObjectKind>
A promise that resolves with the object kind.

writeFile

writeFile(file, path?, options?): Promise<IFileDescriptor>
Writes a file.
Parameters
- file: File
  The file to write.
- Optionalpath: string
  The path to write the file to.
- Optionaloptions: IFileOptions
  The options for writing the file.
Returns Promise<IFileDescriptor>
A promise that resolves with the file descriptor.