Class Stash

Stash API specification.

For more information, read the Getting Started Guide.

All API endpoints are POST operations and any parameters must be fully contained in the request body.

Index

Constructors

constructor

Properties

config

Methods

createKeyspace deleteKeyspace deleteValue destroy getKeyspace getValue incrementValue listKeyspaces listValues setValue

Constructors

constructor

new Stash(configuration: StashClientConfig): Stash
Parameters
- configuration: StashClientConfig
Returns Stash
- Defined in StashClient.ts:267

Properties

`Readonly` config

config: StashClientResolvedConfig

The resolved configuration of StashClient class. This is resolved and normalized from the constructor configuration interface.

Methods

createKeyspace

createKeyspace(args: CreateKeyspaceCommandInput, options?: HttpHandlerOptions): Promise<CreateKeyspaceCommandOutput>
See
CreateKeyspaceCommand
Parameters
- args: CreateKeyspaceCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<CreateKeyspaceCommandOutput>
- Defined in Stash.ts:48
createKeyspace(args: CreateKeyspaceCommandInput, cb: ((err: any, data?: CreateKeyspaceCommandOutput) => void)): void
Parameters
- args: CreateKeyspaceCommandInput
- cb: ((err: any, data?: CreateKeyspaceCommandOutput) => void)
  - - (err: any, data?: CreateKeyspaceCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CreateKeyspaceCommandOutput
      
      Returns void
Returns void
- Defined in Stash.ts:52
createKeyspace(args: CreateKeyspaceCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: CreateKeyspaceCommandOutput) => void)): void
Parameters
- args: CreateKeyspaceCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: CreateKeyspaceCommandOutput) => void)
  - - (err: any, data?: CreateKeyspaceCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CreateKeyspaceCommandOutput
      
      Returns void
Returns void
- Defined in Stash.ts:53

deleteKeyspace

deleteKeyspace(args: DeleteKeyspaceCommandInput, options?: HttpHandlerOptions): Promise<DeleteKeyspaceCommandOutput>
See
DeleteKeyspaceCommand
Parameters
- args: DeleteKeyspaceCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DeleteKeyspaceCommandOutput>
- Defined in Stash.ts:62
deleteKeyspace(args: DeleteKeyspaceCommandInput, cb: ((err: any, data?: DeleteKeyspaceCommandOutput) => void)): void
Parameters
- args: DeleteKeyspaceCommandInput
- cb: ((err: any, data?: DeleteKeyspaceCommandOutput) => void)
  - - (err: any, data?: DeleteKeyspaceCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteKeyspaceCommandOutput
      
      Returns void
Returns void
- Defined in Stash.ts:66
deleteKeyspace(args: DeleteKeyspaceCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DeleteKeyspaceCommandOutput) => void)): void
Parameters
- args: DeleteKeyspaceCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DeleteKeyspaceCommandOutput) => void)
  - - (err: any, data?: DeleteKeyspaceCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteKeyspaceCommandOutput
      
      Returns void
Returns void
- Defined in Stash.ts:67

deleteValue

deleteValue(args: DeleteValueCommandInput, options?: HttpHandlerOptions): Promise<DeleteValueCommandOutput>
See
DeleteValueCommand
Parameters
- args: DeleteValueCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DeleteValueCommandOutput>
- Defined in Stash.ts:76
deleteValue(args: DeleteValueCommandInput, cb: ((err: any, data?: DeleteValueCommandOutput) => void)): void
Parameters
- args: DeleteValueCommandInput
- cb: ((err: any, data?: DeleteValueCommandOutput) => void)
  - - (err: any, data?: DeleteValueCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteValueCommandOutput
      
      Returns void
Returns void
- Defined in Stash.ts:77
deleteValue(args: DeleteValueCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DeleteValueCommandOutput) => void)): void
Parameters
- args: DeleteValueCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DeleteValueCommandOutput) => void)
  - - (err: any, data?: DeleteValueCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteValueCommandOutput
      
      Returns void
Returns void
- Defined in Stash.ts:78

destroy

destroy(): void
Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

Returns void
- Defined in StashClient.ts:290

getKeyspace

getKeyspace(args: GetKeyspaceCommandInput, options?: HttpHandlerOptions): Promise<GetKeyspaceCommandOutput>
See
GetKeyspaceCommand
Parameters
- args: GetKeyspaceCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<GetKeyspaceCommandOutput>
- Defined in Stash.ts:87
getKeyspace(args: GetKeyspaceCommandInput, cb: ((err: any, data?: GetKeyspaceCommandOutput) => void)): void
Parameters
- args: GetKeyspaceCommandInput
- cb: ((err: any, data?: GetKeyspaceCommandOutput) => void)
  - - (err: any, data?: GetKeyspaceCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: GetKeyspaceCommandOutput
      
      Returns void
Returns void
- Defined in Stash.ts:88
getKeyspace(args: GetKeyspaceCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: GetKeyspaceCommandOutput) => void)): void
Parameters
- args: GetKeyspaceCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: GetKeyspaceCommandOutput) => void)
  - - (err: any, data?: GetKeyspaceCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: GetKeyspaceCommandOutput
      
      Returns void
Returns void
- Defined in Stash.ts:89

getValue

getValue(args: GetValueCommandInput, options?: HttpHandlerOptions): Promise<GetValueCommandOutput>
See
GetValueCommand
Parameters
- args: GetValueCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<GetValueCommandOutput>
- Defined in Stash.ts:98
getValue(args: GetValueCommandInput, cb: ((err: any, data?: GetValueCommandOutput) => void)): void
Parameters
- args: GetValueCommandInput
- cb: ((err: any, data?: GetValueCommandOutput) => void)
  - - (err: any, data?: GetValueCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: GetValueCommandOutput
      
      Returns void
Returns void
- Defined in Stash.ts:99
getValue(args: GetValueCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: GetValueCommandOutput) => void)): void
Parameters
- args: GetValueCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: GetValueCommandOutput) => void)
  - - (err: any, data?: GetValueCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: GetValueCommandOutput
      
      Returns void
Returns void
- Defined in Stash.ts:100

incrementValue

incrementValue(args: IncrementValueCommandInput, options?: HttpHandlerOptions): Promise<IncrementValueCommandOutput>
See
IncrementValueCommand
Parameters
- args: IncrementValueCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<IncrementValueCommandOutput>
- Defined in Stash.ts:109
incrementValue(args: IncrementValueCommandInput, cb: ((err: any, data?: IncrementValueCommandOutput) => void)): void
Parameters
- args: IncrementValueCommandInput
- cb: ((err: any, data?: IncrementValueCommandOutput) => void)
  - - (err: any, data?: IncrementValueCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: IncrementValueCommandOutput
      
      Returns void
Returns void
- Defined in Stash.ts:113
incrementValue(args: IncrementValueCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: IncrementValueCommandOutput) => void)): void
Parameters
- args: IncrementValueCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: IncrementValueCommandOutput) => void)
  - - (err: any, data?: IncrementValueCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: IncrementValueCommandOutput
      
      Returns void
Returns void
- Defined in Stash.ts:114

listKeyspaces

listKeyspaces(args: ListKeyspacesCommandInput, options?: HttpHandlerOptions): Promise<ListKeyspacesCommandOutput>
See
ListKeyspacesCommand
Parameters
- args: ListKeyspacesCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<ListKeyspacesCommandOutput>
- Defined in Stash.ts:123
listKeyspaces(args: ListKeyspacesCommandInput, cb: ((err: any, data?: ListKeyspacesCommandOutput) => void)): void
Parameters
- args: ListKeyspacesCommandInput
- cb: ((err: any, data?: ListKeyspacesCommandOutput) => void)
  - - (err: any, data?: ListKeyspacesCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListKeyspacesCommandOutput
      
      Returns void
Returns void
- Defined in Stash.ts:124
listKeyspaces(args: ListKeyspacesCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: ListKeyspacesCommandOutput) => void)): void
Parameters
- args: ListKeyspacesCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: ListKeyspacesCommandOutput) => void)
  - - (err: any, data?: ListKeyspacesCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListKeyspacesCommandOutput
      
      Returns void
Returns void
- Defined in Stash.ts:125

listValues

listValues(args: ListValuesCommandInput, options?: HttpHandlerOptions): Promise<ListValuesCommandOutput>
See
ListValuesCommand
Parameters
- args: ListValuesCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<ListValuesCommandOutput>
- Defined in Stash.ts:134
listValues(args: ListValuesCommandInput, cb: ((err: any, data?: ListValuesCommandOutput) => void)): void
Parameters
- args: ListValuesCommandInput
- cb: ((err: any, data?: ListValuesCommandOutput) => void)
  - - (err: any, data?: ListValuesCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListValuesCommandOutput
      
      Returns void
Returns void
- Defined in Stash.ts:135
listValues(args: ListValuesCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: ListValuesCommandOutput) => void)): void
Parameters
- args: ListValuesCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: ListValuesCommandOutput) => void)
  - - (err: any, data?: ListValuesCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListValuesCommandOutput
      
      Returns void
Returns void
- Defined in Stash.ts:136

setValue

setValue(args: SetValueCommandInput, options?: HttpHandlerOptions): Promise<SetValueCommandOutput>
See
SetValueCommand
Parameters
- args: SetValueCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<SetValueCommandOutput>
- Defined in Stash.ts:145
setValue(args: SetValueCommandInput, cb: ((err: any, data?: SetValueCommandOutput) => void)): void
Parameters
- args: SetValueCommandInput
- cb: ((err: any, data?: SetValueCommandOutput) => void)
  - - (err: any, data?: SetValueCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: SetValueCommandOutput
      
      Returns void
Returns void
- Defined in Stash.ts:146
setValue(args: SetValueCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: SetValueCommandOutput) => void)): void
Parameters
- args: SetValueCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: SetValueCommandOutput) => void)
  - - (err: any, data?: SetValueCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: SetValueCommandOutput
      
      Returns void
Returns void
- Defined in Stash.ts:147

Class Stash

Hierarchy

Implements

Implemented by

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: StashClientConfig

Returns Stash

Properties

Readonly config

Methods

createKeyspace

See

Parameters

args: CreateKeyspaceCommandInput

Optional options: HttpHandlerOptions

Returns Promise<CreateKeyspaceCommandOutput>

Parameters

args: CreateKeyspaceCommandInput

cb: ((err: any, data?: CreateKeyspaceCommandOutput) => void)

Parameters

err: any

Optional data: CreateKeyspaceCommandOutput

Returns void

Returns void

Parameters

args: CreateKeyspaceCommandInput

options: HttpHandlerOptions

cb: ((err: any, data?: CreateKeyspaceCommandOutput) => void)

Parameters

err: any

Optional data: CreateKeyspaceCommandOutput

Returns void

Returns void

deleteKeyspace

See

Parameters

args: DeleteKeyspaceCommandInput

Optional options: HttpHandlerOptions

Returns Promise<DeleteKeyspaceCommandOutput>

Parameters

args: DeleteKeyspaceCommandInput

cb: ((err: any, data?: DeleteKeyspaceCommandOutput) => void)

Parameters

err: any

Optional data: DeleteKeyspaceCommandOutput

Returns void

Returns void

Parameters

args: DeleteKeyspaceCommandInput

options: HttpHandlerOptions

cb: ((err: any, data?: DeleteKeyspaceCommandOutput) => void)

Parameters

err: any

Optional data: DeleteKeyspaceCommandOutput

Returns void

Returns void

deleteValue

See

Parameters

args: DeleteValueCommandInput

Optional options: HttpHandlerOptions

Returns Promise<DeleteValueCommandOutput>

Parameters

args: DeleteValueCommandInput

cb: ((err: any, data?: DeleteValueCommandOutput) => void)

Parameters

err: any

Optional data: DeleteValueCommandOutput

Returns void

Returns void

Parameters

args: DeleteValueCommandInput

options: HttpHandlerOptions

cb: ((err: any, data?: DeleteValueCommandOutput) => void)

`Readonly` config

`Optional` options: HttpHandlerOptions

`Optional` data: CreateKeyspaceCommandOutput

`Optional` data: CreateKeyspaceCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: DeleteKeyspaceCommandOutput

`Optional` data: DeleteKeyspaceCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: DeleteValueCommandOutput

`Optional` data: DeleteValueCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: GetKeyspaceCommandOutput

`Optional` data: GetKeyspaceCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: GetValueCommandOutput

`Optional` data: GetValueCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: IncrementValueCommandOutput