Interface: StorageWriter

server.StorageWriter

An interface to write files to storage within Convex mutation functions.

Hierarchy

• StorageReader

  ↳ StorageWriter

  ↳↳ StorageActionWriter

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.

Parameters

Name	Type	Description
storageId	GenericId<"_storage">	The Id<"_storage"> of the file to fetch from Convex storage.

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

Defined in

server/storage.ts:51

▸ 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

Name	Type
T	extends string

Parameters

Name	Type	Description
storageId	T extends { __tableName: any } ? never : T	The StorageId of the file to fetch from Convex storage.

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

Defined in

server/storage.ts:63

---

getMetadata

▸ getMetadata(storageId): Promise<null | FileMetadata>

Deprecated

This function is deprecated, use db.system.get(Id<"_storage">) instead.

Get metadata for a file.

Parameters

Name	Type	Description
storageId	GenericId<"_storage">	The Id<"_storage"> of the file.

Returns

Promise<null | FileMetadata>

• A FileMetadata object if found or null if not found.

Inherited from

StorageReader.getMetadata

Defined in

server/storage.ts:75

▸ getMetadata<T>(storageId): Promise<null | FileMetadata>

Deprecated

This function is deprecated, use db.system.get(Id<"_storage">) instead.

Get metadata for a file.

Type parameters

Name	Type
T	extends string

Parameters

Name	Type	Description
storageId	T extends { __tableName: any } ? never : T	The StorageId of the file.

Returns

Promise<null | FileMetadata>

• A FileMetadata object if found or null if not found.

Inherited from

StorageReader.getMetadata

Defined in

server/storage.ts:85

---

generateUploadUrl

▸ generateUploadUrl(): Promise<string>

Fetch a short-lived URL for uploading a file into storage.

Upon a POST request to this URL, the endpoint will return a JSON object containing a newly allocated Id<"_storage">.

The POST URL accepts an optional standard HTTP Digest header with a sha256 checksum.

Returns

Promise<string>

• A url that allows file upload via an HTTP POST.

Defined in

server/storage.ts:105

---

delete

▸ delete(storageId): Promise<void>

Delete a file from Convex storage.

Once a file is deleted, any URLs previously generated by getUrl will return 404s.

Parameters

Name	Type	Description
storageId	GenericId<"_storage">	The Id<"_storage"> of the file to delete from Convex storage.

Returns

Promise<void>

Defined in

server/storage.ts:113

▸ delete<T>(storageId): Promise<void>

Deprecated

Passing a string is deprecated, use storage.delete(Id<"_storage">) instead.

Delete a file from Convex storage.

Once a file is deleted, any URLs previously generated by getUrl will return 404s.

Type parameters

Name	Type
T	extends string

Parameters

Name	Type	Description
storageId	T extends { __tableName: any } ? never : T	The StorageId of the file to delete from Convex storage.

Returns

Promise<void>

Defined in

server/storage.ts:124