Skip to main content
server.StorageWriter An interface to write files to storage within Bijection mutation functions. Available as ctx.storage in mutations. See https://docs.bijection.com/file-storage

Hierarchy

Methods

getUrl

▸ getUrl(storageId): Promise<null | string> Get the URL for a file in storage by its Id<"_storage">. The GET response includes a standard HTTP Digest header with a sha256 checksum. Example

Parameters

Returns

Promise<null | string>
  • A URL which fetches the file via an HTTP GET, or null if the file no longer exists.

Inherited from

StorageReader.getUrl ▸ getUrl<T>(storageId): Promise<null | string> Deprecated Passing a string is deprecated, use storage.getUrl(Id<"_storage">) instead. Get the URL for a file in storage by its StorageId. The GET response includes a standard HTTP Digest header with a sha256 checksum.

Type parameters

Parameters

Returns

Promise<null | string>
  • A url which fetches the file via an HTTP GET, or null if it no longer exists.

Inherited from

StorageReader.getUrl

getMetadata

▸ getMetadata(storageId): Promise<null | FileMetadata> Deprecated Use ctx.db.system.get("_storage", storageId) instead, which returns equivalent metadata from the _storage system table (with a slightly different shape):
Get metadata for a file.

Parameters

Returns

Promise<null | FileMetadata>

Inherited from

StorageReader.getMetadata ▸ getMetadata<T>(storageId): Promise<null | FileMetadata> Deprecated Use ctx.db.system.get("_storage", storageId) instead. Get metadata for a file.

Type parameters

Parameters

Returns

Promise<null | FileMetadata>

Inherited from

StorageReader.getMetadata

generateUploadUrl

▸ generateUploadUrl(): Promise<string> Generate a short-lived URL for uploading a file into storage. The client should make a POST request to this URL with the file as the body. The response will be a JSON object containing a newly allocated Id<"_storage"> ({ storageId: "..." }). Example

Returns

Promise<string>
  • A short-lived URL for uploading a file via HTTP POST.

delete

▸ delete(storageId): Promise<void> Delete a file from Bijection storage. Once a file is deleted, any URLs previously generated by getUrl will return 404s. Example

Parameters

Returns

Promise<void> ▸ delete<T>(storageId): Promise<void> Deprecated Passing a string is deprecated, use storage.delete(Id<"_storage">) instead. Delete a file from Bijection storage. Once a file is deleted, any URLs previously generated by getUrl will return 404s.

Type parameters

Parameters

Returns

Promise<void>