Home
Tutorials
Getting Started
Overview
Installing backendjs
Creating a Web Server
Creating a module
Next steps
Modules
NPM packages as modules
Message passing
Default methods
Reference
Dependencies
Configuration
Config sources
Environment variables
Backend library development (Mac OS X, developers)
Config parameters
api
api.access
api.acl
api.csrf
api.passkey
api.redirect
api.routing
api.session
api.signature
api.static
api.users
api.ws
app
aws
cache
db
events
file
image
ipc
jobs
logwatcher
push
queue
sendmail
sql
stats
The bkjs tool
Environment
Functions
Extending bkjs tool
Modules
api
checkProxy
checkRateLimits
checkRequestPlaceholders
cleanupHeaders
cleanupResult
createWebServer
getResultPage
handleBody
handleCleanup
handleMetrics
handleMultipart
init
prepareOptions
prepareRequest
registerPreHeaders
registerRateLimits
replacePath
sendFile
sendFormatted
sendJSON
sendReply
sendStatus
shutdown
startMetrics
toParams
api/access
allow
authenticate
authorize
configureMiddleware
middleware
setUser
api/acl
isAllowed
isAnonymous
isAuthenticated
isDenied
isMatched
isPublic
reset
api/csrf
check
checkFetchSite
checkOrigin
api/hooks
api/passkey
api/redirect
check
api/routing
check
api/session
check
clear
create
getCookie
makeCookie
save
setCookie
setup
api/signature
create
fromRequest
get
verify
api/static
api/users
aadd
add
adel
aget
aupdate
auth
del
get
login
logout
update
api/ws
broadcast
notify
app
addModule
ainit
arunMethods
checkConfig
createRepl
describeArgs
init
isOk
killBackend
loadModules
loadPackages
mime
origin
parseArgs
parseConfig
processArg
processArgs
processEnvArgs
runMethod
runMethods
setHome
setHost
setLogInspect
setRole
sortModules
start
startRepl
stop
watchTmp
aws
batchGetSecrets
configureJob
cwGetMetricData
cwListMetrics
cwPutLogEvents
cwPutMetricAlarm
cwPutMetricData
cwlFilterLogEvents
ddbBatchGetItem
ddbBatchWriteItem
ddbCreateTable
ddbDeleteItem
ddbDeleteTable
ddbDescribeTable
ddbDescribeTimeToLive
ddbGetItem
ddbListTables
ddbPutItem
ddbQueryTable
ddbScanTable
ddbTransactWriteItems
ddbUpdateItem
ddbUpdateTable
ddbUpdateTimeToLive
ddbWaitForTable
detectLabels
ec2AssociateAddress
ec2AttachNetworkInterface
ec2CreateImage
ec2CreateTags
ec2DeregisterImage
ec2DescribeInstances
ec2DescribeSecurityGroups
ec2DescribeSubnets
ec2RunInstances
ec2WaitForInstance
ecsDescribeTasks
ecsPrepareTask
ecsRunTask
ecsTaskProtection
elb2DeregisterInstances
elb2RegisterInstances
fromDynamoDB
getInstanceCredentials
getInstanceDetails
getInstanceInfo
getInstanceMeta
getInstanceMetaToken
getSecretValue
getTaskDetails
listCertificates
parseXMLResponse
queryACM
queryAS
queryAWS
queryCFN
queryCW
queryCWL
queryComprehend
queryDDB
queryEC2
queryECR
queryECS
queryELB2
queryElastiCache
queryEndpoint
queryEvents
queryIAM
queryPrepare
queryRekognition
queryRoute53
queryRoute53Domains
queryS3
querySES
querySNS
querySQS
querySSM
querySTS
querySecrets
queryService
querySign
queryTranscribe
readConfig
readCredentials
route53Change
route53Create
route53Get
route53List
s3CopyFile
s3GetFile
s3List
s3ParseUrl
s3Proxy
s3PutFile
sesSendEmail
sesSendRawEmail
sesSendRawEmail2
signS3
snsConfirmSubscription
snsCreatePlatformEndpoint
snsCreateTopic
snsDeleteEndpoint
snsDeleteTopic
snsListTopics
snsPublish
snsSetEndpointAttributes
snsSetSubscriptionAttributes
snsSetTopicAttributes
snsSubscribe
snsUnsubscribe
sqsReceiveMessage
sqsSendMessage
ssmGetParametersByPath
ssmSendCommand
ssmWaitForCommand
stsAssumeRole
toDynamoDB
cache
aclear
adel
aget
aincr
alock
aput
astats
aunlock
checkConfig
checkLimiter
clear
createClient
del
get
getClient
incr
initClients
limiter
localLimiter
lock
put
shutdown
stats
unlock
color
color.contrast
color.darker
color.hex
color.hex2rgb
color.hsl
color.hsl2rgb
color.lighter
color.luminance
color.negate
color.rluminance
color.rotate
color.yiq
mix
db
aadd
abatch
abulk
acopy
acreate
add
adel
adelAll
adrop
aget
aincr
alist
applyPoolOptions
aput
aquery
ascan
asearch
aselect
asql
asubmitJob
atransaction
aupdate
aupdateAll
aupgrade
batch
bulk
cacheColumns
checkCapacity
configTypes
configureCollectStats
convertError
convertRows
copy
create
createTables
del
delAll
describeTables
drop
existsPool
get
getCached
getCapacity
getConfig
getIndexes
getKeys
getPool
getPoolTables
getPools
getProcessRows
getQueryForKeys
incr
init
initColumns
initConfig
initTables
list
parseNameOp
prepare
prepareColumn
prepareQuery
prepareValue
put
query
queryProcessSync
refreshColumns
runProcessRows
scan
search
select
setConfig
setProcessColumns
setProcessRow
sql
transaction
update
updateAll
upgrade
events
putEvent
file
image
image.composite
image.convert
image.create
image.createGradient
image.detect
image.gravityRegion
image.mergeDefaults
image.padding
image.stats
ipc
broadcast
emitMsg
initServer
initWorker
newMsg
sendMsg
jobs
cancelJob
isCancelled
loadCronjobs
markCancelled
scheduleCronjob
scheduleCronjobs
submitJob
lib
AhoCorasick
__
aexecProcess
afetch
afindProcess
areadFile
areadFile
arrayEqual
arrayFlatten
arrayLength
arrayRemove
arrayUnique
aspawnProcess
autoType
base64ToJson
call
cidrRange
clock
clone
configParse
copyFile
cpuStats
daysInMonth
decodeURIComponent
decrypt
deferCallback
deferInterval
deferShutdown
doWhilst
domainName
dropPrivileges
encodeURIComponent
encrypt
entityToText
escapeUnicode
everyParallel
everySeries
execProcess
extend
fetch
findFile
findFileFilter
findFileSync
findProcess
findWords
flatten
forEach
forEachItem
forEachLimit
forEachLine
forEachLineSync
forEachSeries
forEvery
forEveryLimit
forEverySeries
fromBase32
fromBase62
fromBase64url
gcStats
getArg
getArgInt
getHashid
getWorkers
getuid
hash
heapStats
inCidr
inspect
int2ip
ip2int
isArg
isArray
isDST
isDate
isEmpty
isFlag
isFunc
isMatched
isNumber
isNumeric
isObject
isPositive
isPrefix
isSimilar
isString
isTimeRange
isTrue
isUnicode
isUuid
isWord
jsonFormat
jsonFormatPreset
jsonParse
jsonToBase64
killWorkers
loadLocale
localEpoch
log
lzCompress
lzDecompress
makePath
makePathSync
matchAllRegexp
matchRegexp
memoryStats
moveFile
murmurHash3
networkInterfaces
networkStats
newError
normalize
notifyWorkers
now
objGet
objIncr
objKeys
objMult
objSet
objSize
parallel
parseCookies
parseTime
phraseSplit
random
randomBytes
randomFloat
randomInt
randomNum
randomShort
randomUInt
randomUShort
readFile
readFileSync
replaceRegexp
runCallback
series
sfuuid
shuffle
sign
sleep
sortByVersion
spawnProcess
spawnSeries
split
sprintf
statSync
strftimeMap
stringify
suuid
testRegexp
testRegexpObj
textToEntity
textToXml
timingSafeEqual
toBase32
toBase62
toBase64url
toBool
toCamel
toDate
toDigits
toDuration
toEmail
toFlags
toFormat
toMap
toMilliseconds
toMtime
toNumber
toParams
toPrice
toRFC3339
toRegexp
toRegexpMap
toRegexpObj
toSize
toSkip32
toString
toTemplate
toTitle
toUncamel
toUrl
toValue
toVersion
totp
traceError
trim
tryCall
tryCatch
tryLater
tryRequire
typeName
tzName
unescape
unicode2Ascii
unlink
unlinkPath
unlinkPathSync
unlinkSync
uuid
validBool
validNum
validPositive
validValue
validVersion
watchFiles
weekDate
weekOfYear
whilst
wrap
writeLines
xmlParse
zeropad
onDeferCallback
ParamsOptions
lib/JWT
importPrivateKey
importPublicKey
sign
verify
lib/respawn
check
logger
debug
dev
error
info
log
logger
none
prefix
registerLevel
setDebugFilter
setFile
setLevel
setOptions
setSyslog
trace
warn
logwatcher
metrics
incr
take
toJSON
modules
push
configureModule
init
parseDevice
send
shutdown
queue
apublish
asubmit
checkConfig
createClient
drop
getClient
initClients
listen
publish
purge
shutdown
stats
submit
subscribe
unlisten
unsubscribe
sendmail
send
shell
runFile
sendRequest
stats
sql
column
create
delete
drop
expr
get
insert
limit
quote
select
time
update
updateExpr
upgrade
value
valueIn
where
where
stats
watcher
Classes
Counter
DbPool
aquery
cacheColumns
cacheIndexes
closeDb
configure
convertError
exists
nextToken
openDb
prepare
prepareOptions
prepareQuery
query
shutdown
DbRequest
column
DynamoDBPool
ElasticsearchPool
FakeTrace
FetchRequest
parseCookies
toJSON
Histogram
LRUCache
clean
del
get
put
Meter
Pool
SqlPool
nextToken
prepare
prepareUpdateExpr
prepareUpsertExpr
query
Timer
TokenBucket
configure
consume
equal
toArray
toJSON
toString
Trace
destroy
send
start
stop
toString
CacheClient
applyOptions
applyReservedOptions
clear
close
del
get
incr
limiter
lock
put
stats
unlock
LocalCacheClient
RedisCacheClient
WorkerCacheClient
APNPushClient
send
FCMPushClient
SNSPushClient
WebPushClient
DBQueueClient
EventBridgeQueueClient
JSONQueueClient
LocalQueueClient
NatsQueueClient
QueueClient
_poll_del
_poll_get
_poll_run
_poll_update
channel
drop
listen
purge
schedule
submit
unlisten
RedisQueueClient
SNSQueueClient
SQSQueueClient
WorkerQueueClient
Global
ConfigOptions
DbConfigOptions
DbRequestColumn
DbRequestOptions
DbResultCallback
DbTable
DbTableColumn
DbUser
SESTransport
SendGridTransport
LocalQueueClient
module:queue
.
LocalQueueClient
Client that uses the local process or server process for jobs.
Constructor
new LocalQueueClient
()
Source:
queue/local.js
,
line 15