Class Storage

Hierarchy (view full)

ApillonModule
- Storage

Index

Constructors

constructor

new Storage(config?): Storage
Parameters
- Optional config: ApillonConfig
Returns Storage
Inherited from ApillonModule.constructor
- Defined in lib/apillon.ts:47

Properties

`Private` API_PREFIX

API_PREFIX: string = '/storage'

API url for storage.

`Protected` config

config: ApillonConfig

Methods

createBucket

createBucket(data): Promise<StorageBucket>
Creates a new storage bucket.
Parameters
- data: ICreateStorageBucket
  Data for creating the bucket.
Returns Promise<StorageBucket>
A StorageBucket instance.
- Defined in modules/storage/storage.ts:23

listBuckets

listBuckets(params?): Promise<IApillonList<StorageBucket>>
Lists all buckets.
Parameters
- Optional params: IApillonPagination
  Filter for listing collections.
Returns Promise<IApillonList<StorageBucket>>
Array of StorageBucket objects.
- Defined in modules/storage/storage.ts:35

bucket

bucket(uuid): StorageBucket
Parameters
- uuid: string
  Unique bucket identifier.
Returns StorageBucket
An empty instance of StorageBucket.
- Defined in modules/storage/storage.ts:59

getInfo

getInfo(): Promise<StorageInfo>
Gets overall storage info for a project - available and used storage and bandwidth

Returns Promise<StorageInfo>
- Defined in modules/storage/storage.ts:67

getIpfsClusterInfo

getIpfsClusterInfo(): Promise<IpfsClusterInfo>
Gets basic data of an IPFS cluster used by the project.

IPFS clusters contain multiple IPFS nodes but expose a single gateway for accessing content via CID or IPNS.

Apillon clusters (gateways) are not publicly accessible

Returns Promise<IpfsClusterInfo>
Note
Each project has its own secret for generating tokens to access content on the IPFS gateway.
- Defined in modules/storage/storage.ts:80

generateIpfsLink

generateIpfsLink(cid, type?): Promise<string>
Apillon IPFS gateways are private and can only be accessible with a token.
Parameters
- cid: string
  The CID or IPNS address of the fie
- type: "ipns" | "ipfs" = 'ipfs'
  The type of the link to generate based on the gateway. Can be 'ipfs' or 'ipns'.
Returns Promise<string>
The IPFS link where the requested content can be accessed.

Docs
Generate an IPFS link
- Defined in modules/storage/storage.ts:93