Client Module

Classes

Client

Defined in: Client.ts:51

Constructors

Constructor

> new Client(url, options): Client

Defined in: Client.ts:59

HTTP Client for ReductStore

Parameters

url

string

URL to the storage

options

ClientOptions = {}

Returns

Client

Methods

close()

> close(): Promise<void>

Defined in: Client.ts:76

Close underlying HTTP resources (Node.js only).

Returns

Promise<void>

---

createBucket()

> createBucket(name, settings?): Promise<Bucket>

Defined in: Client.ts:99

Create a new bucket

Parameters

name

string

name of the bucket

settings?

BucketSettings

optional settings

Returns

Promise<Bucket>

---

createLifecycle()

> createLifecycle(name, settings): Promise<void>

Defined in: Client.ts:328

Create a new lifecycle policy

Parameters

name

string

name of the lifecycle policy

settings

LifecycleSettings

settings of the lifecycle policy

Returns

Promise<void>

---

createReplication()

> createReplication(name, settings): Promise<void>

Defined in: Client.ts:254

Create a new replication

Parameters

name

string

name of the replication

settings

ReplicationSettings

settings of the replication

Returns

Promise<void>

---

createToken()

> createToken(name, permissionsOrRequest): Promise<string>

Defined in: Client.ts:149

Create a new access token

Parameters

name

string

name of the token

permissionsOrRequest

permissions or token create request

TokenPermissions | TokenCreateRequest

Returns

Promise<string>

the token

Example

const token = await client.createToken("my-token", {fullAccess: true});
const client = new Client("https://play.storage-reduct.dev", {apiToken: token});

---

deleteLifecycle()

> deleteLifecycle(name): Promise<void>

Defined in: Client.ts:369

Delete a lifecycle policy

Parameters

name

string

name of the lifecycle policy

Returns

Promise<void>

---

deleteReplication()

> deleteReplication(name): Promise<void>

Defined in: Client.ts:295

Delete a replication

Parameters

name

string

name of the replication

Returns

Promise<void>

---

deleteToken()

> deleteToken(name): Promise<void>

Defined in: Client.ts:210

Delete a token by name

Parameters

name

string

name of the token

Returns

Promise<void>

---

getBucket()

> getBucket(name): Promise<Bucket>

Defined in: Client.ts:112

Get a bucket by name

Parameters

name

string

name of the bucket

Returns

Promise<Bucket>

---

getBucketList()

> getBucketList(): Promise<BucketInfo[]>

Defined in: Client.ts:86

Get list of buckets

Returns

Promise<BucketInfo[]>

Async

See

BucketInfo

---

getInfo()

> getInfo(): Promise<ServerInfo>

Defined in: Client.ts:68

Get server information

Returns

Promise<ServerInfo>

the data about the server

Async

---

getLifecycle()

> getLifecycle(name): Promise<FullLifecycleInfo>

Defined in: Client.ts:315

Get full information about a lifecycle policy

Parameters

name

string

name of the lifecycle policy

Returns

Promise<FullLifecycleInfo>

the lifecycle policy

---

getLifecycleList()

> getLifecycleList(): Promise<LifecycleInfo[]>

Defined in: Client.ts:303

Get the list of lifecycle policies

Returns

Promise<LifecycleInfo[]>

the list of lifecycle policies

---

getOrCreateBucket()

> getOrCreateBucket(name, settings?): Promise<Bucket>

Defined in: Client.ts:123

Try to create a bucket and get it if it already exists

Parameters

name

string

name of the bucket

settings?

BucketSettings

optional settings

Returns

Promise<Bucket>

---

getReplication()

> getReplication(name): Promise<FullReplicationInfo>

Defined in: Client.ts:241

Get full information about a replication

Parameters

name

string

name of the replication

Returns

Promise<FullReplicationInfo>

the replication

---

getReplicationList()

> getReplicationList(): Promise<ReplicationInfo[]>

Defined in: Client.ts:227

Get the list of replications

Returns

Promise<ReplicationInfo[]>

the list of replications

---

getToken()

> getToken(name): Promise<Token>

Defined in: Client.ts:188

Get a token by name

Parameters

name

string

name of the token

Returns

Promise<Token>

the token

---

getTokenList()

> getTokenList(): Promise<Token[]>

Defined in: Client.ts:199

List all tokens

Returns

Promise<Token[]>

the list of tokens

---

me()

> me(): Promise<Token>

Defined in: Client.ts:218

Get current API token and its permissions

Returns

Promise<Token>

the token

---

rotateToken()

> rotateToken(name): Promise<string>

Defined in: Client.ts:175

Rotate a token by name

Parameters

name

string

name of the token

Returns

Promise<string>

new token value

---

setLifecycleMode()

> setLifecycleMode(name, mode): Promise<void>

Defined in: Client.ts:360

Update lifecycle mode without changing settings

Parameters

name

string

name of the lifecycle policy

mode

LifecycleMode

new mode: enabled, disabled, or dry_run

Returns

Promise<void>

---

setReplicationMode()

> setReplicationMode(name, mode): Promise<void>

Defined in: Client.ts:286

Update replication mode without changing settings

Parameters

name

string

name of the replication

mode

ReplicationMode

new mode: enabled, paused, or disabled

Returns

Promise<void>

---

updateLifecycle()

> updateLifecycle(name, settings): Promise<void>

Defined in: Client.ts:344

Update a lifecycle policy

Parameters

name

string

name of the lifecycle policy

settings

LifecycleSettings

settings of the lifecycle policy

Returns

Promise<void>

---

updateReplication()

> updateReplication(name, settings): Promise<void>

Defined in: Client.ts:270

Update a replication

Parameters

name

string

name of the replication

settings

ReplicationSettings

settings of the replication

Returns

Promise<void>