Module: types
Interfaces
- Abortable
- AgentDataModel
- AgentMeta
- BlobLike
- Block
- CARFile
- CARMetadata
- Capability
- ClientFactory
- ClientFactoryOptions
- Connectable
- ConnectionView
- Delegation
- DelegationMeta
- FileLike
- ListRequestOptions
- ListResponse
- Pageable
- Principal
- RequestOptions
- Retryable
- ServiceConf
- ShardStoringOptions
- ShardingOptions
- StoreListResult
- UCANBlock
- UCANOptions
- UploadAddResponse
- UploadListResult
- UploadOptions
References
Client
Re-exports Client
Type Aliases
Abilities
Ƭ Abilities: TupleToUnion<AbilitiesArray>
Defined in
node_modules/@web3-storage/capabilities/dist/src/types.d.ts:23
Ability
Ƭ Ability: `${string}/${string}` | "*"
A string that represents some action that a UCAN holder can do.
Defined in
node_modules/@ipld/dag-ucan/dist/src/ucan.d.ts:188
AgentDataExport
Ƭ AgentDataExport: Pick<AgentDataModel, "meta" | "currentSpace" | "spaces"> & { delegations: Map<CIDString, { delegation: { bytes: Uint8Array ; cid: CIDString }[] ; meta: DelegationMeta }> ; principal: SignerArchive<DID, SigAlg> }
Agent data that is safe to pass to structuredClone() and persisted by stores.
Defined in
node_modules/@web3-storage/access/dist/src/types.d.ts:62
AnyLink
Ƭ AnyLink: Link<unknown, number, number, Version>
Any IPLD link.
Defined in
node_modules/@web3-storage/upload-client/dist/src/types.d.ts:103
CARLink
Ƭ CARLink: Link<unknown, typeof CAR.codec.code>
An IPLD Link that has the CAR codec code.
Defined in
node_modules/@web3-storage/upload-client/dist/src/types.d.ts:99
Capabilities
Ƭ Capabilities: Tuple<Capability>
Defined in
node_modules/@ipld/dag-ucan/dist/src/ucan.d.ts:205
DID
Ƭ DID<Method>: `did:${Method}:${string}`
A string-encoded decentralized identity document (DID).
Type parameters
| Name | Type |
|---|---|
Method | extends string = string |
Defined in
node_modules/@ipld/dag-ucan/dist/src/ucan.d.ts:18
StoreAdd
Ƭ StoreAdd: InferInvokedCapability<typeof add>
Defined in
node_modules/@web3-storage/capabilities/dist/src/types.d.ts:19
StoreAddResponse
Ƭ StoreAddResponse: StoreAddDoneResponse | StoreAddUploadRequiredResponse
Defined in
node_modules/@web3-storage/upload-client/dist/src/types.d.ts:19
StoreList
Ƭ StoreList: InferInvokedCapability<typeof list>
Defined in
node_modules/@web3-storage/capabilities/dist/src/types.d.ts:21
StoreRemove
Ƭ StoreRemove: InferInvokedCapability<typeof remove>
Defined in
node_modules/@web3-storage/capabilities/dist/src/types.d.ts:20
UnknownLink
Ƭ UnknownLink: LegacyLink<unknown> | Link<unknown, number, number, Version>
Defined in
node_modules/multiformats/dist/types/src/link/interface.d.ts:35
UploadAdd
Ƭ UploadAdd: InferInvokedCapability<typeof UploadCaps.add>
Defined in
node_modules/@web3-storage/capabilities/dist/src/types.d.ts:15
UploadList
Ƭ UploadList: InferInvokedCapability<typeof UploadCaps.list>
Defined in
node_modules/@web3-storage/capabilities/dist/src/types.d.ts:17
UploadRemove
Ƭ UploadRemove: InferInvokedCapability<typeof UploadCaps.remove>
Defined in
node_modules/@web3-storage/capabilities/dist/src/types.d.ts:16