0.4.8 • Published 3 years ago
@blackglory/chan-js v0.4.8
chan-js
Install
npm install --save @blackglory/chan-js
# or
yarn add @blackglory/chan-js
API
ChanClient
new ChanClient({
server: string
, token?: string
, keepalive?: boolean
, timeout?: number
})
interface IChanClientRequestOptions {
signal?: AbortSignal
token?: string
keepalive?: boolean
timeout?: number | false
}
enqueue
ChanClient#enqueue(
namespace: string
, val: string
, options?: IChanClientRequestOptions
): Promise<void>
enqueueJSON
ChanClient#enqueueJSON(
namespace: string
, val: string
, options?: IChanClientRequestOptions
): Promise<void>
dequeue
ChanClient#dequeue(
namespace: string
, options?: IChanClientRequestOptions
): Promise<string>
dequeueJSON
ChanClient#dequeueJSON(
namespace: string
, options?: IChanClientRequestOptions
): Promise<Json>
ChanManager
new ChanManager({
server: string
, adminPassword: string
, keepalive?: boolean
, timeout?: number
})
interface IChanManagerRequestOptions {
signal?: AbortSignal
keepalive?: boolean
timeout?: number | false
}
JsonSchema
getNamespaces
ChanManager#JsonSchema.getNamespaces(
options?: IChanManagerRequestOptions
): Promise<string[]>
get
ChanManager#JsonSchema.get(
namespace: string
, options?: IChanManagerRequestOptions
): Promise<Json>
set
ChanManager#JsonSchema.set(
namespace: string
, schema: Json
, options?: IChanManagerRequestOptions
): Promise<void>
remove
ChanManager#JsonSchema.remove(
namespace: string
, options?: IChanManagerRequestOptions
): Promise<void>
Blacklist
getNamespaces
ChanManager#Blacklist.getNamespaces(
options?: IChanManagerRequestOptions
): Promise<string[]>
add
ChanManager#Blacklist.add(
namespace: string
, options?: IChanManagerRequestOptionso
): Promise<void>
remove
ChanManager#Blacklist.remove(
namespace: string
, options?: IChanManagerRequestOptions
): Promise<void>
Whitelist
getNamespace
ChanManager#Whitelist.getNamespaces(
options?: IChanManagerRequestOptions
): Promise<string[]>
add
ChanManager#Whitelist.add(
namespace: string
, options?: IChanManagerRequestOptions
): Promise<void>
remove
ChanManager#Whitelist.remove(
namespace: string
, options?: IChanManagerRequestOptions
): Promise<void>
TokenPolicy
getIds
ChanManager#TokenPolicy.getIds(options?: IChanManagerRequestOptions): Promise<string[]>
get
ChanManager#TokenPolicy.get(
namespace: string
, options?: IChanManagerRequestOptions
): Promise<{
writeTokenRequired: boolean | null
readTokenRequired: boolean | null
}>
setWriteTokenRequired
ChanManager#TokenPolicy.setWriteTokenRequired(
namespace: string
, val: boolean
, options?: IChanManagerRequestOptions
): Promise<void>
removeWriteTokenRequired
ChanManager#TokenPolicy.removeWriteTokenRequired(
namespace: string
, options?: IChanManagerRequestOptions
): Promise<void>
setReadTokenRequired
ChanManager#TokenPolicy.setReadTokenRequired(
namespace: string
, val: boolean
, options?: IChanManagerRequestOptions
): Promise<void>
removeReadTokenRequired
ChanManager#TokenPolicy.removeReadTokenRequired(
namespace: string
, options?: IChanManagerRequestOptions
): Promise<void>
Token
getNamespaces
ChanManager#Token.getNamespaces(options?: IChanManagerRequestOptions): Promise<string[]>
getTokens
ChanManager#Token.getTokens(
namespace: string
, options?: IChanManagerRequestOptions
): Promise<Array<{
token: string
write: boolean
read: boolean
}>>
addWriteToken
ChanManager#Token.addWriteToken(
namespace: string
, token: string
, options?: IChanManagerRequestOptions
): Promise<void>
removeWriteToken
ChanManager#Token.removeWriteToken(
namespace: string
, token: string
, options?: IChanManagerRequestOptions
): Promise<void>
addReadToken
ChanManager#Token.addReadToken(
namespace: string
, token: string
, options?: IChanManagerRequestOptions
): Promise<void>
removeReadToken
ChanManager#Token.removeReadToken(
namespace: string
, token: string
, options?: IChanManagerRequestOptions
): Promise<void>
0.4.8
3 years ago
0.4.7
3 years ago
0.4.6
3 years ago
0.4.5
3 years ago
0.4.4
3 years ago
0.4.3
3 years ago
0.4.2
3 years ago
0.4.1
3 years ago
0.4.0
3 years ago
0.3.5
3 years ago
0.3.4
3 years ago
0.3.2
3 years ago
0.3.3
3 years ago
0.3.1
3 years ago
0.3.0
3 years ago
0.2.26
3 years ago
0.2.25
3 years ago
0.2.24
3 years ago
0.2.23
3 years ago
0.2.22
3 years ago
0.2.21
3 years ago
0.2.20
3 years ago
0.2.19
3 years ago
0.2.18
3 years ago
0.2.17
3 years ago
0.2.16
3 years ago
0.2.15
3 years ago
0.2.14
3 years ago
0.2.13
3 years ago
0.2.12
3 years ago
0.2.11
3 years ago
0.2.10
3 years ago
0.2.9
3 years ago
0.2.8
3 years ago
0.2.7
3 years ago
0.2.6
3 years ago
0.2.5
3 years ago
0.2.4
3 years ago
0.2.2
3 years ago
0.2.1
3 years ago
0.2.0
3 years ago
0.1.0
3 years ago