Skip to main content
Version: 1.19.x

Client

Defined in: Client.ts:43

Constructors​

Constructor​

> new Client(url, options): Client

Defined in: Client.ts:51

HTTP Client for ReductStore

Parameters​

url​

string

URL to the storage

options​

ClientOptions = {}

Returns​

Client

Methods​

close()​

> close(): Promise<void>

Defined in: Client.ts:68

Close underlying HTTP resources (Node.js only).

Returns​

Promise<void>

createBucket()​

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

Defined in: Client.ts:91

Create a new bucket

Parameters​

name​

string

name of the bucket

settings?​

BucketSettings

optional settings

Returns​

Promise<Bucket>

createReplication()​

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

Defined in: Client.ts:246

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:141

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,
});

deleteReplication()​

> deleteReplication(name): Promise<void>

Defined in: Client.ts:287

Delete a replication

Parameters​

name​

string

name of the replication

Returns​

Promise<void>

deleteToken()​

> deleteToken(name): Promise<void>

Defined in: Client.ts:202

Delete a token by name

Parameters​

name​

string

name of the token

Returns​

Promise<void>

getBucket()​

> getBucket(name): Promise<Bucket>

Defined in: Client.ts:104

Get a bucket by name

Parameters​

name​

string

name of the bucket

Returns​

Promise<Bucket>

getBucketList()​

> getBucketList(): Promise<BucketInfo[]>

Defined in: Client.ts:78

Get list of buckets

Returns​

Promise<BucketInfo[]>

Async​

See​

BucketInfo

getInfo()​

> getInfo(): Promise<ServerInfo>

Defined in: Client.ts:60

Get server information

Returns​

Promise<ServerInfo>

the data about the server

Async​

getOrCreateBucket()​

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

Defined in: Client.ts:115

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:233

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:219

Get the list of replications

Returns​

Promise<ReplicationInfo[]>

the list of replications

getToken()​

> getToken(name): Promise<Token>

Defined in: Client.ts:180

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:191

List all tokens

Returns​

Promise<Token[]>

the list of tokens

me()​

> me(): Promise<Token>

Defined in: Client.ts:210

Get current API token and its permissions

Returns​

Promise<Token>

the token

rotateToken()​

> rotateToken(name): Promise<string>

Defined in: Client.ts:167

Rotate a token by name

Parameters​

name​

string

name of the token

Returns​

Promise<string>

new token value

setReplicationMode()​

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

Defined in: Client.ts:278

Update replication mode without changing settings

Parameters​

name​

string

name of the replication

mode​

ReplicationMode

new mode: enabled, paused, or disabled

Returns​

Promise<void>

updateReplication()​

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

Defined in: Client.ts:262

Update a replication

Parameters​

name​

string

name of the replication

settings​

ReplicationSettings

settings of the replication

Returns​

Promise<void>