Class- Client
The Client class represents a client that can be used to communicate with Object Storage from Replit. It provides methods for interacting with Objects stored in Object Storage Buckets.
Constructors
constructor
Creates a new client instance with optional configurations.
- new Client(
options?):Client
Parameters
| Name | Type | Description |
|---|---|---|
options? | ClientOptions | configurations to setup the client. |
Returns
Returns a new instance of the Client class.
Defined in
Methods
The Client class provides the following methods for interacting with Objects stored in Object Storage Buckets. Each method offers functionality for performing specific operations such as copying, deleting, and downloading Objects.
copy
Copies the specified Object within the same Bucket. If an Object exists in the same location, it will be overwritten.
▸ copy(objectName, destObjectName): PromiseResultnull, RequestError>>
Parameters
| Name | Type | Description |
|---|---|---|
objectName | string | The full path of the Object to copy. |
destObjectName | string | The full path to copy the Object to. |
Returns
A promise that resolves when the operation is successful or rejects with an error.
PromiseResultnull, RequestError>>
Defined in
delete
Deletes the specified Object from Object Storage.
▸ delete(objectName, options?): PromiseResultnull, RequestError>>
Parameters
| Name | Type | Description |
|---|---|---|
objectName | string | The full path of the Object to delete. |
options? | DeleteOptions | Configurations for the delete operation. |
Returns
A promise that resolves when the operation is successful or rejects with an error.
PromiseResultnull, RequestError>>
Defined in
downloadAsBytes
Downloads an Object as a buffer containing the Object’s raw contents.
▸ downloadAsBytes(objectName, options?): PromiseResult[Buffer], RequestError>>
Parameters
| Name | Type | Description |
|---|---|---|
objectName | string | The full path of the Object to download. |
options? | DownloadOptions | Configurations for the download operation. |
Returns
A promise that resolves with a buffer containing the Object’s contents or rejects with an error.
PromiseResult[Buffer], RequestError>>
Defined in
downloadAsStream
Opens a new stream and streams the Object’s contents. If an error is encountered, it will be emitted through the stream.
▸ downloadAsStream(objectName, options?): Readable
Parameters
| Name | Type | Description |
|---|---|---|
objectName | string | The full path of the Object to download. |
options? | DownloadOptions | Configurations for the download operation. |
Returns
A readable stream containing the Object’s contents.
Readable
Defined in
downloadAsText
Downloads a Object to a string and returns the string.
▸ downloadAsText(objectName, options?): PromiseResultstring, RequestError>>
Parameters
| Name | Type | Description |
|---|---|---|
objectName | string | The full path of the Object to download. |
options? | DownloadOptions | Configurations for the download operation. |
Returns
A promise that resolves with a string containing the Object’s contents or rejects with an error.
PromiseResultstring, RequestError>>
Defined in
downloadToFilename
Downloads an Object to the local filesystem.
▸ downloadToFilename(objectName, destFilename, options?): PromiseResultnull, RequestError>>
Parameters
| Name | Type | Description |
|---|---|---|
objectName | string | The full path of the Object to download. |
destFilename | string | The path on the local filesystem to write the downloaded Object to. |
options? | DownloadOptions | Configurations for the download operation. |
Returns
A promise that resolves when the operation is successful or rejects with an error.
PromiseResultnull, RequestError>>
Defined in
exists
Checks whether the given Object exists.
▸ exists(objectName): PromiseResultboolean, RequestError>>
Parameters
| Name | Type | Description |
|---|---|---|
objectName | string | The full path of the Object to check. |
Returns
A promise that resolves with a boolean indicating whether the Object exists in the specified Bucket. If the Object exists, the promise resolves to true; otherwise, it resolves to false. If an error occurs during the operation, the promise rejects with a RequestError containing details about the error.
PromiseResultboolean, RequestError>>
Defined in
list
Lists Objects in the Bucket.
▸ list(options?): PromiseResultStorageObject[], RequestError>>
Parameters
| Name | Type | Description |
|---|---|---|
options? | ListOptions | Configurations for the list operation. |
Returns
A promise that resolves with an array of StorageObject instances representing the Objects in the Bucket. Each StorageObject contains metadata about a specific Object stored in the Bucket.
PromiseResultStorageObject[], RequestError>>
Defined in
uploadFromBytes
▸ uploadFromBytes(objectName, contents, options?): PromiseResultnull, RequestError>>
Uploads an Object from its in-memory byte representation. If an Object already exists with the specified name it will be overwritten.
Parameters
| Name | Type | Description |
|---|---|---|
objectName | string | The full destination path of the Object. |
contents | Buffer | The raw contents of the Object in byte form. |
options? | UploadOptions | Configurations for the upload operation. |
Returns
PromiseResultnull, RequestError>>
Defined in
uploadFromFilename
▸ uploadFromFilename(objectName, srcFilename, options?): PromiseResultnull, RequestError>>
Uploads an Object from a file on the local filesystem. If an Object already exists with the specified name it will be overwritten.
Parameters
| Name | Type | Description |
|---|---|---|
objectName | string | The full destination path of the Object. |
srcFilename | string | The path of the file on the local filesystem to upload. |
options? | UploadOptions | Configurations for the upload operation. |
Returns
PromiseResultnull, RequestError>>
Defined in
uploadFromStream
▸ uploadFromStream(objectName, stream, options?): Promisevoid>
Uploads an Object by streaming its contents from the provided stream. If an error is encountered, it will be emitted through the stream. If an Object already exists with the specified name it will be overwritten.
Parameters
| Name | Type | Description |
|---|---|---|
objectName | string | The full destination path of the Object. |
stream | Readable | A writeable stream the Object will be written from. |
options? | UploadOptions | Configurations for the upload operation. |
Returns
Promisevoid>
Defined in
uploadFromText
▸ uploadFromText(objectName, contents, options?): PromiseResultnull, RequestError>>
Uploads an Object from its in-memory text representation. If an Object already exists with the specified name it will be overwritten.
Parameters
| Name | Type | Description |
|---|---|---|
objectName | string | The full destination path of the Object. |
contents | string | The contents of the Object in text form. |
options? | UploadOptions | Configurations for the upload operation. |
Returns
PromiseResultnull, RequestError>>
Defined in
Was this page helpful?