Interfaces
- ClientOptions
- DeleteOptions
- DownloadOptions
- ErrResult
- ListOptions
- OkResult
- RequestError
- StorageObject
- UploadOptions
Interface: ClientOptions
Configuration options for creating a Client.
Properties
bucketId
• Optional bucketId: string
The ID of the Bucket the Client will interact with. If none is specified, the default Bucket will be used.
Defined in
This interface defines the configuration options that can be provided when creating a Client instance for interacting with Object Storage. The bucketId property specifies the ID of the Bucket to be used. If no bucketId is provided, the Client will interact with the default Bucket.
Interface: DeleteOptions
Configuration options for deleting an Object.
Properties
ignoreNotFound
• Optional ignoreNotFound: boolean
Specifies whether to ignore errors if the specified Object does not exist. If set to true, no error will be raised if the Object is not found. By default, this property is set to false.
Defined in
This interface defines the configuration options that can be provided when deleting an Object from Object Storage. The ignoreNotFound property specifies whether to ignore errors if the specified Object does not exist. By default, the value is false, meaning an error will be raised if the Object is not found.
Interface: DownloadOptions
Configuration options for downloading an Object.
Properties
decompress
• Optional decompress: boolean
Specifies whether the Object should be decompressed if it was uploaded using the compress flag. By default, this property is set to true, indicating that the Object should be decompressed during download.
Defined in
This interface defines the configuration options that can be provided when downloading an Object from Object Storage. The decompress property specifies whether the Object should be decompressed if it was uploaded with compression enabled. By default, the value is true, meaning that the Object will be decompressed during download.
Interface: ErrResult<E, ErrorExtras>
Represents a failure result.
Type parameters
| Name | Type | Description |
|---|---|---|
E | E | The type of the error. |
ErrorExtras | unknown | The type of any additional information on the error, if provided. |
Properties
error
• error: E
The error that occurred.
Defined in
errorExtras
• Optional errorExtras: ErrorExtras
Additional information on the error, if applicable.
Defined in
ok
• ok: false
Indicates that the request was unsuccessful.
Defined in
value
• Optional value: undefined
Always undefined when the request was successful.
Defined in
This interface represents a result Object indicating a failed operation. It contains information about the error that occurred (error), any additional details related to the error (errorExtras), and a flag indicating that the request was unsuccessful (ok). The value property is always undefined in case of a failure.
Interface: ListOptions
Configuration options for listing Objects in a Bucket.
Properties
endOffset
• Optional endOffset: string
Filter results to Objects whose names are lexicographically before endOffset. If startOffset is also set, the objects listed have names between startOffset (inclusive) and endOffset (exclusive).
Defined in
matchGlob
• Optional matchGlob: string
Glob pattern used to filter results, for example foo*bar.
Defined in
maxResults
• Optional maxResults: number
The maximum number of results that can be returned in the response.
Defined in
prefix
• Optional prefix: string
Filter results to objects who names have the specified prefix.
Defined in
startOffset
• Optional startOffset: string
Filter results to objects whose names are lexicographically equal to or after startOffset. If endOffset is also set, the objects listed have names between startOffset (inclusive) and endOffset (exclusive).
Defined in
This interface defines configuration options for listing objects in a Bucket. It includes properties such as endOffset, matchGlob, maxResults, prefix, and startOffset, each with its description and defined location in the source code.
Interface: OkResult<T>
Represents a successful result.
Type parameters
| Name | Description |
|---|---|
T | The type of the result's value. |
Properties
error
• Optional error: undefined
Always undefined when the request was successful.
Defined in
ok
• ok: true
Indicates that the request was successful.
Defined in
value
• value: T
The value returned by the request.
Defined in
This interface represents a successful result, containing information about the success status (ok), the returned value (value), and an optional error property, which is always undefined in case of success.
Interface: RequestError
An Object that represents an error with a request.
Properties
message
• message: string
Represents the error message associated with the request error.
Defined in
statusCode
• Optional statusCode: number
Represents the status code associated with the request error.
Defined in
Interface: StorageObject
Metadata for an Object.
Properties
name
• name: string
The name of the Object, including its full path.
Defined in
This interface represents metadata for an Object, providing information about the Object's name, including its full path.
Interface: UploadOptions
Configuration options for uploading an Object.
Properties
compress
• Optional compress: boolean
Specifies whether the Object should be compressed upon receipt of data. Enabling compression reduces at-rest storage cost but does not impact data transfer. By default, this property is set to true.
Defined in
This interface defines configuration options for uploading an Object to Object Storage. The compress property specifies whether the Object should be compressed upon receipt of data. Enabling compression reduces at-rest storage cost, with the default behavior set to compress the Object (true).