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
Environment variables
Backend library development (Mac OS X, developers)
Config parameters
api
api.access
api.acl
api.csrf
api.files
api.images
api.passkey
api.redirect
api.routing
api.session
api.signature
api.static
api.users
api.ws
app
aws
cache
db
events
ipc
jobs
logwatcher
push
queue
sendmail
sql
stats
The bkjs tool
Environment
Functions
Extending bkjs tool
Modules
api
checkProxy
checkRateLimits
checkRedirectPlaceholders
cleanupHeaders
cleanupResult
createWebServer
getResultPage
getTokenSecret
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
clear
get
skip
verify
api/files
copy
del
detect
detectStore
getUrl
list
put
read
send
store
api/hooks
api/images
del
getPath
getUrl
isImage
isUrl
put
save
scale
send
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
aws.cwGetMetricData
aws.cwListMetrics
aws.cwPutLogEvents
aws.cwPutMetricAlarm
aws.cwPutMetricData
aws.cwlFilterLogEvents
aws.ddbBatchGetItem
aws.ddbBatchWriteItem
aws.ddbCreateTable
aws.ddbDeleteItem
aws.ddbDeleteTable
aws.ddbDescribeTable
aws.ddbDescribeTimeToLive
aws.ddbGetItem
aws.ddbListTables
aws.ddbPutItem
aws.ddbQueryTable
aws.ddbScanTable
aws.ddbTransactWriteItems
aws.ddbUpdateItem
aws.ddbUpdateTable
aws.ddbUpdateTimeToLive
aws.ddbWaitForTable
aws.ec2AssociateAddress
aws.ec2AttachNetworkInterface
aws.ec2CreateImage
aws.ec2CreateTags
aws.ec2DeregisterImage
aws.ec2DescribeInstances
aws.ec2DescribeSubnets
aws.ec2RunInstances
aws.ec2WaitForInstance
aws.elb2DeregisterInstances
aws.elb2RegisterInstances
aws.fromDynamoDB
aws.getTagValue
aws.queryACM
aws.queryAS
aws.queryCFN
aws.queryCW
aws.queryCWL
aws.queryComprehend
aws.queryDDB
aws.queryEC2
aws.queryECR
aws.queryELB2
aws.queryElastiCache
aws.queryEvents
aws.queryIAM
aws.queryRekognition
aws.queryS3
aws.querySNS
aws.querySSM
aws.querySTS
aws.queryTranscribe
aws.s3CopyFile
aws.s3GetFile
aws.s3List
aws.s3ParseUrl
aws.s3Proxy
aws.s3PutFile
aws.signS3
aws.snsConfirmSubscription
aws.snsCreatePlatformEndpoint
aws.snsCreateTopic
aws.snsDeleteEndpoint
aws.snsDeleteTopic
aws.snsListTopics
aws.snsPublish
aws.snsSetEndpointAttributes
aws.snsSetSubscriptionAttributes
aws.snsSetTopicAttributes
aws.snsSubscribe
aws.snsUnsubscribe
aws.ssmSendCommand
aws.ssmWaitForCommand
aws.toDynamoDB
detectLabels
ecsDescribeTasks
ecsPrepareTask
ecsRunTask
ecsTaskProtection
getInstanceCredentials
getInstanceDetails
getInstanceInfo
getInstanceMeta
getInstanceMetaToken
getTaskDetails
listCertificates
parseXMLResponse
queryAWS
queryECS
queryEndpoint
queryRoute53
queryRoute53Domains
querySES
querySQS
queryService
querySign
readConfig
readCredentials
route53Change
route53Create
route53Get
route53List
sesSendEmail
sesSendRawEmail
sesSendRawEmail2
sqsReceiveMessage
sqsSendMessage
stsAssumeRole
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
db
aadd
abatch
abulk
acopy
acreate
add
adel
adelAll
adrop
aget
aincr
alist
applyPoolOptions
aput
aquery
ascan
asearch
aselect
asql
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
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
configParse
copyFile
cpuStats
daysInMonth
decodeURIComponent
decrypt
deferCallback
deferInterval
deferShutdown
doWhilst
domainName
dropPrivileges
encodeURIComponent
encrypt
entityToText
escapeUnicode
everyParallel
everySeries
execProcess
fetch
findFile
findFileFilter
findFileSync
findProcess
findWords
forEach
forEachItem
forEachLimit
forEachLine
forEachLineSync
forEachSeries
forEvery
forEveryLimit
forEverySeries
fromBase32
fromBase62
fromBase64url
gcStats
getArg
getArgInt
getHashid
getWorkers
getuid
hash
heapStats
inCidr
int2ip
ip2int
isArg
isArray
isDST
isDate
isEmpty
isFlag
isFunc
isMatched
isNumber
isNumeric
isObject
isPositive
isPrefix
isSimilar
isString
isTimeRange
isTrue
isUnicode
isUuid
isValidBool
isValidNum
isValidPositive
isValidVersion
isWord
jsonFormat
jsonFormatPreset
jsonParse
jsonToBase64
killWorkers
loadLocale
localEpoch
log
makePath
makePathSync
matchAllRegexp
matchRegexp
memoryStats
moveFile
murmurHash3
networkInterfaces
networkStats
newError
normalize
notifyWorkers
now
objClone
objDescr
objExtend
objFlatten
objGet
objIncr
objKeys
objMerge
objMult
objSearch
objSet
objSize
parallel
parseCookies
parseTime
phraseSplit
random
randomBytes
randomFloat
randomInt
randomNum
randomShort
randomUInt
randomUShort
readFile
readFileSync
replaceRegexp
runCallback
series
sfuuid
shuffle
sign
sleep
slug
sortByVersion
spawnProcess
spawnSeries
split
sprintf
statSync
strCompress
strDecompress
strTrim
strWrap
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
tryCall
tryCatch
tryLater
tryRequire
typeName
tzName
unescape
unicode2Ascii
unlink
unlinkPath
unlinkPathSync
unlinkSync
uuid
watchFiles
weekDate
weekOfYear
whilst
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
monitor
publish
shutdown
stats
submit
subscribe
unlisten
unsubscribe
sendmail
send
shell
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
FakeTrace
FetchOptions
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
exports
delay
CacheClient
applyOptions
applyReservedOptions
clear
close
del
get
incr
limiter
lock
put
stats
unlock
LocalClient
RedisClient
WorkerClient
APNClient
send
FCMClient
SNSClient
WebpushClient
EventBridgeClient
JSONClient
LocalClient
NatsClient
QueueClient
channel
monitor
schedule
RedisClient
SNSClient
SQSClient
WorkerClient
Global
ConfigOptions
DbConfigOptions
DbRequestColumn
DbRequestOptions
DbResultCallback
DbTable
DbTableColumn
DbUser
LocalClient
module:cache
.
LocalClient
Client that uses the local process or server process for jobs.
Constructor
new LocalClient
()
Source:
cache/local.js
,
line 14