README.md

RedisSMQ Common Library / Docs / API Reference

API Reference

Table of contents

Enumerations

• ERedisConfigClient
• EWorkerThreadChildExecutionCode
• EWorkerThreadChildExitCode
• EWorkerThreadParentMessage
• EWorkerType

Classes

• EventBus
• EventBusRedis
• EventEmitter
• Locker
• PowerSwitch
• Runnable
• Timer
• WorkerCallable
• WorkerResourceGroup
• WorkerRunnable

Error Classes

• AbortError
• CallbackEmptyReplyError
• CallbackInvalidReplyError
• EventBusError
• EventBusNotConnectedError
• LockAcquireError
• LockError
• LockExtendError
• LockMethodNotAllowedError
• LockNotAcquiredError
• LoggerError
• PanicError
• RedisClientError
• RedisSMQError
• TimerError
• WatchedKeysChangedError
• WorkerAlreadyDownError
• WorkerAlreadyRunningError
• WorkerError
• WorkerPayloadRequiredError
• WorkerThreadError

Interfaces

• ICallback
• IEventBus
• IEventEmitter
• ILogger
• ILoggerConfig
• IRedisClient
• IRedisConfig
• IRedisTransaction
• IWorkerCallable
• IWorkerRunnable
• IWorkerThreadData

Type Aliases

• TEventBusEvent
• TEventEmitterEvent
• TFunction
• TLockerEvent
• TRedisClientEvent
• TTimer
• TTimerEvent
• TUnaryFunction
• TWorkerCallableFunction
• TWorkerFunction
• TWorkerResourceGroupEvent
• TWorkerRunnableFunctionFactory
• TWorkerThreadChildMessage
• TWorkerThreadChildMessageCode
• TWorkerThreadParentMessage
• TWorkerThreadParentMessageCall
• TWorkerThreadParentMessageRun
• TWorkerThreadParentMessageShutdown

Variables

• async
• logger

Functions

• createRedisClient
• getDirname

Type Aliases

TEventBusEvent

Ƭ TEventBusEvent: TEventEmitterEvent & { error: (err: Error) => void }

---

TEventEmitterEvent

Ƭ TEventEmitterEvent: Record<string, (...args: any[]) => void>

---

TFunction

Ƭ TFunction<TReturn, TArgs>: (...args: TArgs[]) => TReturn

Type parameters

Name	Type
TReturn	void
TArgs	any

Type declaration

▸ (...args): TReturn

Parameters

Name	Type
...args	TArgs[]

Returns

TReturn

---

TLockerEvent

Ƭ TLockerEvent: Object

Type declaration

Name	Type
locker.down	(id: string) => void
locker.error	(error: Error, id: string) => void
locker.goingDown	(id: string) => void
locker.goingUp	(id: string) => void
locker.up	(id: string) => void

---

TRedisClientEvent

Ƭ TRedisClientEvent: Object

Type declaration

Name	Type
end	() => void
error	(err: Error) => void
message	(channel: string, message: string) => void
pmessage	(pattern: string, channel: string, message: string) => void
ready	() => void

---

TTimer

Ƭ TTimer: Object

Type declaration

Name	Type
fn	TFunction
periodic	boolean
timer	NodeJS.Timeout

---

TTimerEvent

Ƭ TTimerEvent: Object

Type declaration

Name	Type
error	(err: Error) => void

---

TUnaryFunction

Ƭ TUnaryFunction<T, E>: (reply: T) => E

Type parameters

Name	Type
T	T
E	void

Type declaration

▸ (reply): E

Parameters

Name	Type
reply	T

Returns

E

---

TWorkerCallableFunction

Ƭ TWorkerCallableFunction: (args: unknown, cb: ICallback<unknown>) => void

Type declaration

▸ (args, cb): void

Parameters

Name	Type
args	unknown
cb	ICallback<unknown>

Returns

void

---

TWorkerFunction

Ƭ TWorkerFunction: TWorkerRunnableFunctionFactory | TWorkerCallableFunction

---

TWorkerResourceGroupEvent

Ƭ TWorkerResourceGroupEvent: Object

Type declaration

Name	Type
workerResourceGroup.error	(err: Error) => void

---

TWorkerRunnableFunctionFactory

Ƭ TWorkerRunnableFunctionFactory: (initialPayload: unknown) => IWorkerRunnable

Type declaration

▸ (initialPayload): IWorkerRunnable

Parameters

Name	Type
initialPayload	unknown

Returns

IWorkerRunnable

---

TWorkerThreadChildError

Ƭ TWorkerThreadChildError: Object

Type declaration

Name	Type
message	string
name	string

---

TWorkerThreadChildMessage

Ƭ TWorkerThreadChildMessage<Data>: Object

Type parameters

Name	Type
Data	unknown

Type declaration

Name	Type
code	TWorkerThreadChildMessageCode
data?	Data
error?	TWorkerThreadChildError | null

---

TWorkerThreadChildMessageCode

Ƭ TWorkerThreadChildMessageCode: EWorkerThreadChildExitCode | EWorkerThreadChildExecutionCode

---

TWorkerThreadParentMessage

Ƭ TWorkerThreadParentMessage: TWorkerThreadParentMessageCall | TWorkerThreadParentMessageRun | TWorkerThreadParentMessageShutdown

---

TWorkerThreadParentMessageCall

Ƭ TWorkerThreadParentMessageCall: Object

Type declaration

Name	Type
payload	unknown
type	CALL

---

TWorkerThreadParentMessageRun

Ƭ TWorkerThreadParentMessageRun: Object

Type declaration

Name	Type
type	RUN

---

TWorkerThreadParentMessageShutdown

Ƭ TWorkerThreadParentMessageShutdown: Object

Type declaration

Name	Type
type	SHUTDOWN

Variables

async

• Const async: Object

Type declaration

Name	Type
each	<T>(collection: Record<string, T> | T[], iteratee: (item: T, key: string | number, callback: ICallback<void>) => void, callback: ICallback<void>) => void
eachIn	<T>(collection: Record<string, T>, iteratee: (item: T, key: string, callback: ICallback<void>) => void, callback: ICallback<void>) => void
eachOf	<T>(collection: T[], iteratee: (item: T, key: number, callback: ICallback<void>) => void, callback: ICallback<void>) => void
waterfall	<T>(tasks: TFunction<void, any>[], callback: ICallback<T>) => void

---

logger

• Const logger: Object

Type declaration

Name	Type
destroy	() => void
getLogger	(cfg: ILoggerConfig, ns?: string) => ILogger
setLogger	<T>(logger: T) => void

Functions

createRedisClient

▸ createRedisClient(config, cb): void

Parameters

Name	Type
config	IRedisConfig
cb	ICallback<IRedisClient>

Returns

void

---

getDirname

▸ getDirname(): string

Returns

string