Class StorageBucket

Hierarchy (view full)

ApillonModel
- StorageBucket

Index

Constructors

constructor

new StorageBucket(uuid, data?): StorageBucket
Constructor which should only be called via Storage class.
Parameters
- uuid: string
  Unique identifier of the bucket.
- Optional data: Partial<StorageBucket>
  Data to populate storage bucket with.
Returns StorageBucket
Overrides ApillonModel.constructor
- Defined in modules/storage/storage-bucket.ts:53

Properties

name

name: string = null

Name of the bucket.

description

description: string = null

Bucket description.

size

size: number = null

Size of the bucket in bytes.

bucketType

bucketType: BucketType = null

Type of bucket (storage, hosting or NFT metadata)

content

content: (File | Directory)[] = []

Bucket content which are files and directories.

`Protected` API_PREFIX

API_PREFIX: string = null

API url prefix for this class.

uuid

uuid: string

Unique identifier of the model.

createTime

createTime: string = null

The object's creation date

updateTime

updateTime: string = null

The date when the object was last updated

Methods

listObjects

listObjects(params?): Promise<IApillonList<File | Directory>>
Gets contents of a bucket.
Parameters
- Optional params: IStorageBucketContentRequest
Returns Promise<IApillonList<File | Directory>>
A a list of File and Directory objects.
- Defined in modules/storage/storage-bucket.ts:63

listFiles

listFiles(params?): Promise<IApillonList<File>>
Gets all files in a bucket.
Parameters
- Optional params: IBucketFilesRequest
  query filter parameters
Returns Promise<IApillonList<File>>
List of files in the bucket
- Defined in modules/storage/storage-bucket.ts:94

uploadFromFolder

uploadFromFolder(folderPath, params?): Promise<FileUploadResult[]>
Uploads files inside a local folder via path.
Parameters
- folderPath: string
  Path to the folder to upload.
- Optional params: IFileUploadRequest
  Optional parameters to be used for uploading files
Returns Promise<FileUploadResult[]>
List of uploaded files with their properties
- Defined in modules/storage/storage-bucket.ts:114

uploadFiles

uploadFiles(files, params?): Promise<FileUploadResult[]>
Uploads files to the bucket.
Parameters
- files: FileMetadata[]
  The files to be uploaded
- Optional params: IFileUploadRequest
  Optional parameters to be used for uploading files
Returns Promise<FileUploadResult[]>
- Defined in modules/storage/storage-bucket.ts:132

file

file(fileUuid): File
Gets file instance.
Parameters
- fileUuid: string
  UUID of the file.
Returns File
File instance.
- Defined in modules/storage/storage-bucket.ts:150

`Private` resolveFileCIDs

resolveFileCIDs(sessionUuid, limit): Promise<FileUploadResult[]>
Parameters
- sessionUuid: string
- limit: number
Returns Promise<FileUploadResult[]>
- Defined in modules/storage/storage-bucket.ts:163

`Private` getUploadedFiles

getUploadedFiles(sessionUuid, limit): Promise<{
    fileName: string;
    fileUuid: string;
    CID: string;
}[]>
Parameters
- sessionUuid: string
- limit: number
Returns Promise<{
    fileName: string;
    fileUuid: string;
    CID: string;
}[]>
- Defined in modules/storage/storage-bucket.ts:184

ipns

ipns(ipnsUuid): Ipns
Gets an IPNS record instance.
Parameters
- ipnsUuid: string
  UUID of the IPNS record.
Returns Ipns
Ipns instance.
- Defined in modules/storage/storage-bucket.ts:200

listIpnsNames

listIpnsNames(params?): Promise<{
items: Ipns[];
total: number;
}>
List all IPNS records for this bucket
Parameters
- Optional params: IPNSListRequest
  Listing query filters
Returns Promise<{
items: Ipns[];
total: number;
}>
List of IPNS names in the bucket
- Defined in modules/storage/storage-bucket.ts:209

createIpns

createIpns(body): Promise<Ipns>
Create a new IPNS record for this bucket
Parameters
- body: ICreateIpns
Returns Promise<Ipns>
New IPNS instance
- Defined in modules/storage/storage-bucket.ts:226

`Protected` serializeFilter

serializeFilter(key, value): any
Define and exclude custom keys from serialized object
Parameters
- key: string
- value: any
Returns any
Overrides ApillonModel.serializeFilter
- Defined in modules/storage/storage-bucket.ts:235

get

get(): Promise<StorageBucket>
Gets and populates the object details of this entity

Returns Promise<StorageBucket>
A new instance of this object
Inherited from ApillonModel.get
- Defined in lib/apillon.ts:84

`Protected` populate

populate(data): StorageBucket
Populates class properties via data object.
Parameters
- data: object
  Data object.
Returns StorageBucket
Inherited from ApillonModel.populate
- Defined in lib/apillon.ts:93

serialize

serialize(): any
Convert object to JSON output, with unnecessary properties excluded

Returns any
Inherited from ApillonModel.serialize
- Defined in lib/apillon.ts:107

Class StorageBucket

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns StorageBucket

Properties

name

description

size

bucketType

content

Protected API_PREFIX

uuid

createTime

updateTime

Methods

listObjects

Parameters

Returns Promise<IApillonList<File | Directory>>

listFiles

Parameters

Returns Promise<IApillonList<File>>

uploadFromFolder

Parameters

Returns Promise<FileUploadResult[]>

uploadFiles

Parameters

Returns Promise<FileUploadResult[]>

file

Parameters

Returns File

directory

Parameters

Returns Directory

Private resolveFileCIDs

Parameters

Returns Promise<FileUploadResult[]>

Private getUploadedFiles

Parameters

Returns Promise<{ fileName: string; fileUuid: string; CID: string; }[]>

ipns

Parameters

Returns Ipns

listIpnsNames

Parameters

Returns Promise<{ items: Ipns[]; total: number; }>

createIpns

Parameters

Returns Promise<Ipns>

Protected serializeFilter

Parameters

Returns any

get

Returns Promise<StorageBucket>

Protected populate

Parameters

Returns StorageBucket

serialize

Returns any

Settings

Member Visibility

Theme

On This Page

`Protected` API_PREFIX

`Private` resolveFileCIDs

`Private` getUploadedFiles

Returns Promise<{
fileName: string;
fileUuid: string;
CID: string;
}[]>

Returns Promise<{
items: Ipns[];
total: number;
}>

`Protected` serializeFilter

`Protected` populate