@blackglory/mq-js

npm install --save @blackglory/mq-js

Usage no npm install needed!

<script type="module">
  import blackgloryMqJs from 'https://cdn.skypack.dev/@blackglory/mq-js';
</script>

README

mq-js

Install

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

API

MQClient

new MQClient({
  server: string
, token?: string
, basicAuth?: {
    username: string
  , password: string
  }
, keepalive?: boolean
, timeout?: number
})

interface IMQClientRequestOptions {
  signal?: AbortSignal
  token?: string
  keepalive?: boolean
  timeout?: number | false
}

interface IMQClientRequestOptionsWithoutToken {
  signal?: AbortSignal
  keepalive?: boolean
  timeout?: number | false
}

draft

MQClient#draft(
  namespace: string
, priority?: number | null
, options?: IMQClientRequestOptions
): Promise<string>

set

MQClient#set(
  namespace: string
, id: string
, payload: string
, options?: IMQClientRequestOptions
): Promise<void>

setJSON

MQClient#setJSON(
  namespace: string
, id: string
, payload: Json
, options?: IMQClientRequestOptions
): Promise<void>

order

MQClient#order(namespace: string, options?: IMQClientRequestOptions): Promise<string>

get

MQClient#get(
  namespace: string
, id: string
, options?: IMQClientRequestOptions
): Promise<{
  priority: number | null
  payload: string
}>

getJSON

MQClient#getJSON(
  namespace: string
, id: string
, options?: IMQClientRequestOptions
): Promise<{
  priority: number | null
  payload: Json
}>

abandon

MQClient#abandon(
  namespace: string
, id: string
, options?: IMQClientRequestOptions
): Promise<void>

complete

MQClient#complete(
  namespace: string
, id: string
, options?: IMQClientRequestOptions
): Promise<void>

fail

MQClient#fail(
  namespace: string
, id: string
, options?: IMQClientRequestOptions
): Promise<void>

renew

MQClient#renew(
  namespace: string
, id: string
, options?: IMQClientRequestOptions
): Promise<void>

getAllFailedMessageIds

MQClient#getAllFailedMessageIds(
  namespace: string
, options?: IMQClientRequestOptions
): Promise<string[]>

abandonAllFailedMessages

MQClient#abandonAllFailedMessages(
  namespace: string
, options?: IMQClientRequestOptions
): Promise<void>

renewAllFailedMessages

MQClient#renewAllFailedMessages(
  namespace: string
, options?: IMQClientRequestOptions
): Promise<void>

clear

MQClient#clear(
  namespace: string
, id: string
, options?: IMQClientRequestOptions
): Promise<void>

stats

MQClient#stats(
  namespace: string
, options?: IMQClientRequestOptionsWithoutToken
): Promise<{
  namespace: string
  drafting: number
  waiting: number
  ordered: number
  active: number
  completed: number
  failed: number
}>

getAllQueueIds

MQClient#getAllQueueIds(
  options?: IMQClientRequestOptionsWithoutToken
): Promise<string[]>

MQManager

new MQManager({
  server: string
, adminPassword: string
, keepalive?: boolean
, timeout?: number
})

interface IMQManagerRequestOptions {
  signal?: AbortSignal
  keepalive?: boolean
  timeout?: number | false
}

JsonSchema

getNamespaces
MQManager#JsonSchema.getNamespaces(
  options?: IMQManagerRequestOptions
): Promise<string[]>
get
MQManager#JsonSchema.get(
  namespace: string
, options?: IMQManagerRequestOptions
): Promise<Json>
set
MQManager#JsonSchema.set(
  namespace: string
, schema: Json
, options?: IMQManagerRequestOptions
): Promise<void>
remove
MQManager#JsonSchema.remove(
  namespace: string
, options?: IMQManagerRequestOptions
): Promise<void>

Configuration

getNamespaces
MQManager#Configuration.getNamespaces(
  options?: IMQManagerRequestOptions
): Promise<string[]>
get
MQManager#Configuration.get(
  namespace: string
, options?: IMQManagerRequestOptions
): Promise<{
  unique: boolean | null
  draftTimeout: number | null
  orderedTimeout: number | null
  activeTimeout: number | null
  concurrency: number | null
  throttle: {
    duration: number
    limit
  } | null
}>
setUnique
MQManager#Configuration.setUnique(
  namespace: string
, val: boolean
, options?: IMQManagerRequestOptions
): Promise<void>
removeUnique
MQManager#Configuration.removeUnique(
  namespace: string
, options?: IMQManagerRequestOptions
): Promise<void>
setDraftTimeout
MQManager#Configuration.setDraftTimeout(
  namespace: string
, val: number
, options?: IMQManagerRequestOptions
): Promise<void>
removeDraftTimeout
MQManager#Configuration.removeDraftTimeout(
  namespace: string
, options?: IMQManagerRequestOptions
): Promise<void>
setOrderedTimeout
MQManager#Configuration.setOrderedTimeout(
  namespace: string
, val: number
, options?: IMQManagerRequestOptions
): Promise<void>
removeOrderedTimeout
MQManager#Configuration.removeOrderedTimeout(
  namespace: string
, options?: IMQManagerRequestOptions
): Promise<void>
setActiveTimeout
MQManager#Configuration.setActiveTimeout(
  namespace: string
, val: number
, options?: IMQManagerRequestOptions
): Promise<void>
removeActiveTimeout
MQManager#Configuration.removeActiveTimeout(
  namespace: string
, options?: IMQManagerRequestOptions
): Promise<void>
setConcurrency
MQManager#Configuration.setConcucrrency(
  namespace: string
, val: number
, optinos?: IMQManagerRequestOptions
): Promise<void>
removeConcurrency
MQManager#Configuration.removeConcurrency(
  namespace: string
, options?: IMQManagerRequestOptions
): Promise<void>
setThrottle
MQManager#Configuration.setThrottle(
  namespace: string
, val: {
    duration: number
    limit: number
  }
, options?: IMQManagerRequestOptions
): Promise<void>
removeThrottle
MQManager#Configuration.removeThrottle(
  namespace: string
, options?: IMQManagerRequestOptions
): Promise<void>

Blacklist

getNamespaces
MQManager#Blacklist.getNamespaces(options?: IMQManagerRequestOptions): Promise<string[]>
add
MQManager#Blacklist.add(
  namespace: string
, options?: IMQManagerRequestOptions
): Promise<void>
remove
MQManager#Blacklist.remove(
  namespace: string
, options?: IMQManagerRequestOptions
): Promise<void>

Whitelist

getNamespaces
MQManager#Whitelist.getNamespaces(options?: IMQManagerRequestOptions): Promise<string[]>
add
MQManager#Whitelist.add(
  namespace: string
, options?: IMQManagerRequestOptions
): Promise<void>
remove
MQManager#Whitelist.remove(
  namespace: string
, options?: IMQManagerRequestOptions
): Promise<void>

TokenPolicy

getNamespaces
MQManager#TokenPolicy.getNamespaces(
  options?: IMQManagerRequestOptions
): Promise<string[]>
get
MQManager#TokenPolicy.get(
  namespace: string
, options?: IMQManagerRequestOptions
): Promise<{
  produceTokenRequired: boolean | null
  consumeTokenRequired: boolean | null
  clearTokenRequired: boolean | null
}>
setProduceTokenRequired
MQManager#TokenPolicy.setProduceTokenRequired(
  namespace: string
, val: boolean
, options?: IMQManagerRequestOptions
): Promise<void>
removeProduceTokenRequired
MQManager#TokenPolicy.removeProduceTokenRequired(
  namespace: string
, options?: IMQManagerRequestOptions
): Promise<void>
setConsumeTokenRequired
MQManager#TokenPolicy.setConsumeTokenRequired(
  namespace: string
, val: boolean
, options?: IMQManagerRequestOptions
): Promise<void>
removeConsumeTokenRequired
MQManager#TokenPolicy.removeConsumeTokenRequired(
  namespace: string
, options?: IMQManagerRequestOptions
): Promise<void>
setClearTokenRequired
MQManager#TokenPolicy.setClearTokenRequired(
  namespace: string
, val: boolean
, options?: IMQManagerRequestOptions
): Promise<void>
removeClearTokenRequired
MQManager#TokenPolicy.removeClearTokenRequired(
  namespace: string
, options?: IMQManagerRequestOptions
): Promise<void>

Token

getNamespaces
MQManager#Token.getNamespaces(options?: IMQManagerRequestOptions): Promise<string[]>
getTokens
MQManager#Token.getTokens(
  namespace: string
, options?: IMQManagerRequestOptions
): Promise<Array<{
  token: string
  produce: boolean
  consume: boolean
  clear: boolean
}>>
addProduceToken
MQManager#Token.addProduceToken(
  namespace: string
, token: string
, options?: IMQManagerRequestOptions
): Promise<void>
removeProduceToken
MQManager#Token.removeProduceToken(
  namespace: string
, token: string
, options?: IMQManagerRequestOptions
): Promise<void>
addConsumeToken
MQManager#Token.addConsumeToken(
  namespace: string
, token: string
, options?: IMQManagerRequestOptions
): Promise<void>
removeConsumeToken
MQManager#Token.removeConsumeToken(
  namespace: string
, token: string
, options?: IMQManagerRequestOptions
): Promise<void>
addClearToken
MQManager#Token.addClearToken(
  namespace: string
, token: string
, options?: IMQManagerRequestOptions
): Promise<void>
removeClearToken
MQManager#Token.removeClearToken(
  namespace: string
, token: string
, options?: IMQManagerRequestOptions
): Promise<void>