Classes

StorageRouter

Constructor

constructor(env: Env, domainId: string)

Parameters:

Parameter	Type	Required	Description
`env`	`Env`	Yes
`domainId`	`string`	Yes

Methods

handle

handle(request: Request<unknown, CfProperties<unknown>>): Promise<Response>

Parameters:

Parameter	Type	Required	Description
`request`	`Request<unknown, CfProperties<unknown>>`	Yes

Returns:

Promise<Response> -

StorageService

Constructor

constructor(env: Env, domainId: string)

Parameters:

Parameter	Type	Required	Description
`env`	`Env`	Yes
`domainId`	`string`	Yes

Methods

listCollections

listCollections(): Promise<Response>

Returns:

Promise<Response> -

createCollection

createCollection(request: Request<unknown, CfProperties<unknown>>): Promise<Response>

Parameters:

Parameter	Type	Required	Description
`request`	`Request<unknown, CfProperties<unknown>>`	Yes

Returns:

Promise<Response> -

deleteCollection

deleteCollection(name: string, version: number): Promise<Response>

Parameters:

Parameter	Type	Required	Description
`name`	`string`	Yes
`version`	`number`	Yes

Returns:

Promise<Response> -

listDocuments

listDocuments(collection: string, version: number, searchParams: URLSearchParams): Promise<Response>

Parameters:

Parameter	Type	Required
`collection`	`string`	Yes
`version`	`number`	Yes
`searchParams`	`URLSearchParams`	Yes

Returns:

Promise<Response> -

getDocument

getDocument(collection: string, version: number, id: string): Promise<Response>

Parameters:

Parameter	Type	Required
`collection`	`string`	Yes
`version`	`number`	Yes
`id`	`string`	Yes

Returns:

Promise<Response> -

createDocument

createDocument(collection: string, version: number, request: Request<unknown, CfProperties<unknown>>): Promise<Response>

Parameters:

Parameter	Type	Required
`collection`	`string`	Yes
`version`	`number`	Yes
`request`	`Request<unknown, CfProperties<unknown>>`	Yes

Returns:

Promise<Response> -

updateDocument

updateDocument(collection: string, version: number, id: string, request: Request<unknown, CfProperties<unknown>>): Promise<Response>

Parameters:

Parameter	Type	Required
`collection`	`string`	Yes
`version`	`number`	Yes
`id`	`string`	Yes
`request`	`Request<unknown, CfProperties<unknown>>`	Yes

Returns:

Promise<Response> -

deleteDocument

deleteDocument(collection: string, version: number, id: string): Promise<Response>

Parameters:

Parameter	Type	Required
`collection`	`string`	Yes
`version`	`number`	Yes
`id`	`string`	Yes

Returns:

Promise<Response> -

getStorageAnalytics

getStorageAnalytics(): Promise<Response>

Returns:

Promise<Response> -

queryDocumentsByUpdatedAt

queryDocumentsByUpdatedAt(collection: string, version: number, searchParams: URLSearchParams): Promise<Response>

Parameters:

Parameter	Type	Required
`collection`	`string`	Yes
`version`	`number`	Yes
`searchParams`	`URLSearchParams`	Yes

Returns:

Promise<Response> -

archiveDocument

archiveDocument(collection: string, version: number, id: string, document: StorageDocument): Promise<Response>

Parameters:

Parameter	Type	Required
`collection`	`string`	Yes
`version`	`number`	Yes
`id`	`string`	Yes
`document`	`StorageDocument`	Yes

Returns:

Promise<Response> -

getDocumentHistory

getDocumentHistory(collection: string, version: number, id: string): Promise<Response>

Parameters:

Parameter	Type	Required
`collection`	`string`	Yes
`version`	`number`	Yes
`id`	`string`	Yes

Returns:

Promise<Response> -

collectionExists

collectionExists(collection: string, version: number): Promise<Response>

Parameters:

Parameter	Type	Required	Description
`collection`	`string`	Yes
`version`	`number`	Yes

Returns:

Promise<Response> -

initializeDomainReplication

initializeDomainReplication(): Promise<Response>

Returns:

Promise<Response> -

domainExists

domainExists(): Promise<Response>

Returns:

Promise<Response> -

clearDomainData

clearDomainData(): Promise<Response>

Returns:

Promise<Response> -

ping

ping(): Promise<Response>

Returns:

Promise<Response> -