@imqueueRPC enqueued!

intro docs blog

commercial ↗ $ npm i -g @imqueue/cli

intro docs blog commercial ↗

theme

$ npm i -g @imqueue/cli

@imqueue/rpc v1.17.1 · archived

Classes

Description IMQCache IMQDelay IMQLock IMQMetadata IMQRPCDescription RedisCache

Abstract Classes

IMQClient IMQService

Functions

expose() fileExists(path) forgetPid(name, id, logger, path) imqCallRejector(reject, req, client) imqCallResolver(resolve, req, client) IMQError(code, message, stack, method, args, original) indexed(indexTypedef) lock(enabledOrOptions) logged(options) mkdir(path) osUuid() pid(name, path) property(type, isOptional) remote() send(request, response, service) signature(className, methodName, args) writeFile(path, content)

Interfaces

ArgDescription CacheDecorator CacheDecoratorOptions ICache ICacheConstructor IMQAfterCall IMQBeforeCall IMQClientOptions IMQLockMetadata IMQLockMetadataItem IMQRPCError IMQRPCRequest IMQRPCResponse IMQServiceOptions IRedisCacheOptions LockOptions LoggedDecoratorOptions MethodDescription MethodsCollectionDescription PropertyDescription ReturnValueDescription ServiceClassDescription ServiceDescription Thunk TypeDescription TypesDescription

Variables

AFTER_HOOK_ERROR BEFORE_HOOK_ERROR cache DEFAULT_IMQ_CLIENT_OPTIONS DEFAULT_IMQ_SERVICE_OPTIONS DEFAULT_REDIS_CACHE_OPTIONS IMQ_PID_DIR IMQ_TMP_DIR REDIS_CLIENT_INIT_ERROR SIGNALS

Type Aliases

AcquiredLock ICacheAdapter IMQLockQueue IMQLockTask LoggedLogLevel

Home/API reference/@imqueue/rpc/IMQService/describe

You're viewing archived documentation for @imqueue/rpc v1.17.1. APIs may differ from the current release. View the latest version ↗

IMQService.describe() method

Returns service description metadata.

Signature:

describe(): Description;

Returns:

{Promise}

RPC over an inter-communication messaging queue. For TypeScript & NodeJS back-ends. Friendly to AI assistants.

Docs

Get started Tutorial CLI API MCP

Packages

@imqueue/cli ↗ @imqueue/rpc ↗ @imqueue/core ↗ @imqueue/mcp ↗ Other ↗

Project

GitHub ↗ Sandbox ↗ Contributing License Commercial ↗

Legal

Privacy Policy Terms Of Use Support Contact Cookie settings

@imqueue open source · GPL-3.0 Need a commercial license? imqueue.com ↗

Cookies We'd like to measure how these docs are used. Nothing runs and nothing is stored unless you allow it, you can change your mind any time, and we never sell or share your data. Privacy · Terms · Support

Usage analyticsWhich pages get read and what brought you here, counted in aggregate. Google Analytics. Session replayRecords your clicks, scrolling and pointer movement on the page. Microsoft Clarity.