basalt / storage-gcs/src / GcsFileLike
Interface: GcsFileLike
Defined in: storage-gcs/src/index.ts:44
The subset of a @google-cloud/storage File this driver uses.
Methods
copy()?
> optional copy(destination, options?): Promise<unknown>
Defined in: storage-gcs/src/index.ts:54
Server-side copy inside GCS (same or another bucket of the same project).
Parameters
destination
string | GcsFileLike
options?
metadata?
{ contentType?: string; }
metadata.contentType?
string
Returns
Promise<unknown>
createReadStream()?
> optional createReadStream(): Readable
Defined in: storage-gcs/src/index.ts:52
Returns
Readable
createWriteStream()?
> optional createWriteStream(options?): Writable
Defined in: storage-gcs/src/index.ts:51
Resumable upload sink — GCS chunks whatever is piped into it.
Parameters
options?
contentType?
string
resumable?
boolean
Returns
Writable
delete()
> delete(): Promise<unknown>
Defined in: storage-gcs/src/index.ts:48
Returns
Promise<unknown>
download()
> download(): Promise<[Buffer<ArrayBufferLike>]>
Defined in: storage-gcs/src/index.ts:46
Returns
Promise<[Buffer<ArrayBufferLike>]>
exists()
> exists(): Promise<[boolean]>
Defined in: storage-gcs/src/index.ts:47
Returns
Promise<[boolean]>
getMetadata()?
> optional getMetadata(): Promise<[GcsObjectMetadata]>
Defined in: storage-gcs/src/index.ts:55
Returns
Promise<[GcsObjectMetadata]>
getSignedUrl()
> getSignedUrl(config): Promise<[string]>
Defined in: storage-gcs/src/index.ts:49
Parameters
config
Returns
Promise<[string]>
save()
> save(data, options?): Promise<unknown>
Defined in: storage-gcs/src/index.ts:45
Parameters
data
Buffer
options?
contentType?
string
Returns
Promise<unknown>