@blackglory/geyser-js

geyser-js

Install

npm install --save @blackglory/geyser-js
# or
yarn add @blackglory/geyser-js

API

GeyserClient

new GeyserClient({
  server: string
, token?: string
, keepalive?: boolean
})

interface IGeyserClientRequestOptions {
  signal?: AbortSignal
  token?: string
  keepalive?: boolean
}

acquire

GeyserClient#acquire(id: string, options?: IGeyserClientRequestOptions): Promise<void>

GeyserManager

new GeyserManager({
  server: string
, adminPassword: string
})

interface IGeyserManagerRequestOptions {
  signal?: AbortSignal
}

Configuration

getIds

GeyserManager#Configuration.getIds(options?: IGeyserManagerRequestOptions): Promise<string[]>

get

GeyserManager#Configuration.get(id: string, options?: IGeyserManagerRequestOptions): Promise<{
  duration: number | null
  limit: number | null
}>

setDuration

GeyserManager#Configuration.setDuration(id: string, val: number, options?: IGeyserManagerRequestOptions): Promise<void>

removeDuration

GeyserManager#Configuration.removeDuration(id: string, options?: IGeyserManagerRequestOptions): Promise<void>

setLimit

GeyserManager#Configuration.setLimit(id: string, val: number, options?: IGeyserManagerRequestOptions): Promise<void>

removeLimit

GeyserManager#Configuration.removeLimit(id: string, options?: IGeyserManagerRequestOptions): Promise<void>

Blacklist

getIds

GeyserManager#Blacklist.getIds(options?: IGeyserManagerRequestOptions): Promise<string[]>

add

GeyserManager#Blacklist.add(id: string, options?: IGeyserManagerRequestOptions): Promise<void>

remove

GeyserManager#Blacklist.remove(id: string, options?: IGeyserManagerRequestOptions): Promise<void>

Whitelist

getIds

GeyserManager#Whitelist.getIds(options?: IGeyserManagerRequestOptions): Promise<string[]>

add

GeyserManager#Whitelist.add(id: string, options?: IGeyserManagerRequestOptions): Promise<void>

remove

GeyserManager#Whitelist.remove(id: string, options?: IGeyserManagerRequestOptions): Promise<void>

TokenPolicy

getIds

GeyserManager#TokenPolicy.getIds(options?: IGeyserManagerRequestOptions): Promise<string[]>

get

GeyserManager#TokenPolicy.get(id: string, options?: IGeyserManagerRequestOptions): Promise<{
  acquireTokenRequired: boolean | null
}>

setAcquireTokenRequired

GeyserManager#TokenPolicy.setAcquireTokenRequired(id: string, val: boolean, options?: IGeyserManagerRequestOptions): Promise<void>

removeAcquireTokenRequired

GeyserManager#TokenPolicy.removeAcquireTokenRequired(id: string, options?: IGeyserManagerRequestOptions): Promise<void>

Token

getIds

GeyserManager#Token.getIds(options?: IGeyserManagerRequestOptions): Promise<string[]>

getTokens

GeyserManager#Token.getTokens(id: string, options?: IGeyserManagerRequestOptions): Promise<Array<{
  acquire: boolean
}>>

addAcquireToken

GeyserManager#Token.addAcquireToken(id: string, token: string, options?: IGeyserManagerRequestOptions): Promise<void>

removeAcquireToken

GeyserManager#Token.removeAcquireToken(id: string, token: string, options?: IGeyserManagerRequestOptions): Promise<void>