0.5.1 • Published 2 years ago
@blackglory/nstore-js v0.5.1
nstore-js
Install
npm install --save @blackglory/nstore-js
# or
yarn add @blackglory/nstore-js
API
NStoreClient
new NStoreClient({
server: string
, token?: string
, basicAuth?: {
username: string
, password: string
}
, keepalive?: boolean
, timeout?: number
})
interface INStoreClientRequestOptions {
signal?: AbortSignal
token?: string
keepalive?: boolean
timeout?: number | false
}
interface INStoreClientRequestOptionsWithRevision extends INStoreClientRequestOptions {
revision?: string
}
interface INStoreClientRequestOptionsWithoutToken {
signal?: AbortSignal
keepalive?: boolean
timeout?: number | false
}
Mode
enum Mode {
Exact
, Ceiling
, Floor
, Nearest
, Lower
, Higher
}
set
NStoreClient#set(
namespace: string
, id: bigint
, payload: string
, options?: INStoreClientRequestOptionsWithRevision
): Promise<void>
setJSON
NStoreClient#setJSON(
namespace: string
, id: bigint
, payload: Json
, options?: INStoreClientRequestOptionsWithRevision
): Promise<void>
setCSV
NStoreClient#setJSON<T extends object>(
namespace: string
, id: bigint
, payload: T[]
, options?: INStoreClientRequestOptionsWithRevision
): Promise<void>
has
NStoreClient#has(
namespace: string
, id: bigint
, mode?: Mode
, options?: INStoreClientRequestOptionsWithRevision
): Promise<boolean>
get
NStoreClient#get(
namespace: string
, id: bigint
, mode?: Mode
, options?: INStoreClientRequestOptionsWithRevision
): Promise<{
revision: string
payload: string
} | undefined>
getJSON
NStoreClient#getJSON(
namespace: string
, id: bigint
, mode?: Mode
, options?: INStoreClientRequestOptionsWithRevision
): Promise<{
revision: string
payload: Json
} | undefined>
getCSV
NStoreClient#getCSV<T extends object>(
namespace: string
, id: bigint
, mode?: Mode
, options?: INStoreClientRequestOptionsWithRevision
): Promise<{
revision: string
payload: T[]
} | undefined>
del
NStoreClient#del(
namespace: string
, id: bigint
, options?: INStoreClientRequestOptionsWithRevision
): Promise<void>
clear
NStoreClient#clear(
namespace: string
, options?: INStoreClientRequestOptions
): Promise<void>
getAllItemIds
NStoreClient#getAllItemIds(
namespace: string
, options?: INStoreClientRequestOptions
): Promise<string[]>
getAllNamespaces
NStoreClient#getAllNamespaces(
options?: INStoreClientRequestOptionsWithoutToken
): Promise<string[]>
stats
NStoreClient#stats(
namespace: string
, options?: INStoreClientRequestOptionsWithoutToken
): Promise<<{
namespace: string
items: number
}>
NStoreManager
new NStoreManager({
server: string
adminPassword: string
keepalive?: boolean
timeout?: number
})
interface INStoreManagerRequestOptions {
signal?: AbortSignal
keepalive?: boolean
timeout?: number | false
}
JsonSchema
getNamespaces
NStoreManager#JsonSchema.getNamespaces(
options?: INStoreManagerRequestOptions
): Promise<string[]>
get
NStoreManager#JsonSchema.get(namespace: string, options?: INStoreManagerRequestOptions): Promise<Json>
set
NStoreManager#JsonSchema.set(
namespace: string
, schema: Json
, options?: INStoreManagerRequestOptions
): Promise<void>
remove
NStoreManager#JsonSchema.remove(
namespace: string
, options?: INStoreManagerRequestOptions
): Promise<void>
RevisionPolicy
getNamespaces
NStoreManager#RevisionPolicy.getNamespaces(
options?: INStoreManagerRequestOptions
): Promise<string[]>
get
NStoreManager#RevisionPolicy.get(
namespace: string
, options?: INStoreManagerRequestOptions
): Promise<{
updateRevisionRequired: boolean | null
deleteRevisionRequired: boolean | null
}>
setUpdateRevisionRequired
NStoreManager#RevisionPolicy.setUpdateRevisionRequired(
namespace: string
, val: boolean
, options?: INStoreManagerRequestOptions
): Promise<void>
removeUpdateRevisionRequired
NStoreManager#RevisionPolicy.removeUpdateRevisionRequired(
namespace: string
, options?: INStoreManagerRequestOptions
): Promise<void>
setDeleteRevisionRequired
NStoreManager#RevisionPolicy.setDeleteRevisionRequired(
namespace: string
, val: boolean
, options?: INStoreManagerRequestOptions
): Promise<void>
removeDeleteRevisionRequired
NStoreManager#RevisionPolicy.removeDeleteRevisionRequired(
namespace: string
, options?: INStoreManagerRequestOptions
): Promise<void>
Blacklist
getNamespaces
NStoreManager#Blacklist.getNamespaces(
options?: INStoreManagerRequestOptions
): Promise<string[]>
add
NStoreManager#Blacklist.add(
namespace: string
, options?: INStoreManagerRequestOptions
): Promise<void>
remove
NStoreManager#Blacklist.remove(
namespace: string
, options?: INStoreManagerRequestOptions
): Promise<void>
Whitelist
getNamespaces
NStoreManager#Whitelist.getNamespaces(
options?: INStoreManagerRequestOptions
): Promise<string[]>
add
NStoreManager#Whitelist.add(
namespace: string
, options?: INStoreManagerRequestOptions
): Promise<void>
remove
NStoreManager#Whitelist.remove(
namespace: string
, options?: INStoreManagerRequestOptions
): Promise<void>
TokenPolicy
getNamespaces
NStoreManager#TokenPolicy.getNamespaces(
options?: INStoreManagerRequestOptions
): Promise<string[]>
get
NStoreManager#TokenPolicy.get(
namespace: string
, options?: INStoreManagerRequestOptions
): Promise<{
writeTokenRequired: boolean | null
readTokenRequired: boolean | null
deleteTokenRequired: boolean | null
}>
setWriteTokenRequired
NStoreManager#TokenPolicy.setWriteTokenRequired(
namespace: string
, val: boolean
, options?: INStoreManagerRequestOptions
): Promise<void>
removeWriteTokenRequired
NStoreManager#TokenPolicy.removeWriteTokenRequired(
namespace: string
, options?: INStoreManagerRequestOptions
): Promise<void>
setReadTokenRequired
NStoreManager#TokenPolicy.setReadTokenRequired(
namespace: string
, val: boolean
, options?: INStoreManagerRequestOptions
): Promise<void>
removeReadTokenRequired
NStoreManager#TokenPolicy.removeReadTokenRequired(
namespace: string
, options?: INStoreManagerRequestOptions
): Promise<void>
setDeleteTokenRequired
NStoreManager#TokenPolicy.setDeleteTokenRequired(
namespace: string
, val: boolean
, options?: INStoreManagerRequestOptions
): Promise<void>
removeDeleteTokenRequired
NStoreManager#TokenPolicy.removeDeleteTokenRequired(
namespace: string
, options?: INStoreManagerRequestOptions
): Promise<void>
Token
getNamespaces
NStoreManager#Token.getNamespaces(options?: INStoreManagerRequestOptions): Promise<string[]>
getTokens
NStoreManager#Token.getTokens(
namespace: string
, options?: INStoreManagerRequestOptions
): Promise<Array<{
token: string
write: boolean
read: boolean
delete: boolean
}>>
addWriteToken
NStoreManager#Token.addWriteToken(
namespace: string
, token: string
, options?: INStoreManagerRequestOptions
): Promise<void>
removeWriteToken
NStoreManager#Token.removeWriteToken(
namespace: string
, token: string
, options?: INStoreManagerRequestOptions
): Promise<void>
addReadToken
NStoreManager#Token.addReadToken(
namespace: string
, token: string
, options?: INStoreManagerRequestOptions
): Promise<void>
removeReadToken
NStoreManager#Token.removeReadToken(
namespace: string
, token: string
, options?: INStoreManagerRequestOptions
): Promise<void>
addDeleteToken
NStoreManager#Token.addDeleteToken(
namespace: string
, token: string
, options?: INStoreManagerRequestOptions
): Promise<void>
removeDeleteToken
NStoreManager#Token.removeDeleteToken(
namespace: string
, token: string
, options?: INStoreManagerRequestOptions
): Promise<void>