Interface IObjectStoreConnector

The object store connector interface.

interface IObjectStoreConnector {
    calculateSize(path): Promise<number>;
    createFolder(path): Promise<void>;
    deleteObject(path): Promise<ObjectKind>;
    get(path): Promise<File>;
    list(path, recursive): Promise<ObjectDescriptor[]>;
    moveObject(path, newPath): Promise<ObjectKind>;
    writeFile(file, path?): Promise<void>;
}

Index

Methods

calculateSize createFolder 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<void>
Creates a folder.
Parameters
- path: string
  The path to the folder.
Returns Promise<void>
A promise that resolves when the folder is created.

deleteObject

deleteObject(path): Promise<ObjectKind>
Deletes an object.
Parameters
- path: string
  The path to the object.
Returns Promise<ObjectKind>

get

get(path): Promise<File>
Gets a file.
Parameters
- path: string
  The path to the file.
Returns Promise<File>
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>

writeFile

writeFile(file, path?): Promise<void>
Writes a file.
Parameters
- file: File
  The file to write.
- Optional path: string
  The path to write the file to.
Returns Promise<void>

Generated using TypeDoc