moleculer/src/registry/action-catalog.d.ts

Fast & powerful microservices framework for Node.JS

import type { ActionSchema } from "../service";
import type EndpointList = require("./endpoint-list");
import type Node = require("./node");
import type ServiceItem = require("./service-item");

import type ServiceBroker = require("../service-broker");
import type Registry = require("./registry");
import type Strategy = require("../strategies/base");
import type ActionEndpoint = require("./endpoint-action");

declare namespace ActionCatalog {
	export interface ActionCatalogListOptions {
		onlyLocal?: boolean;
		onlyAvailable?: boolean;
		skipInternal?: boolean;
		withEndpoints?: boolean;
	}

	interface ActionEndpointList {
		nodeID: string;
		state: boolean;
		available: boolean;
	}

	export interface ActionCatalogListResult {
		name: string;
		count: number;
		hasLocal: boolean;
		available: boolean;
		action?: Omit<ActionSchema, "handler" | "remoteHandler" | "service">;
		endpoints?: ActionEndpointList[];
	}
}

declare class ActionCatalog {
	registry: Registry;
	broker: ServiceBroker;
	actions: Map<string, any>;
	StrategyFactory: typeof Strategy;
	EndpointFactory: typeof ActionEndpoint;

	constructor(registry: Registry, broker: ServiceBroker, StrategyFactory: typeof Strategy);

	add(node: Node, service: ServiceItem, action: ActionSchema): EndpointList<ActionEndpoint>;

	get(actionName: string): EndpointList<ActionEndpoint> | undefined;

	isAvailable(actionName: string): boolean;

	removeByService(service: ServiceItem): void;

	remove(actionName: string, nodeID: string): void;

	list(opts: ActionCatalog.ActionCatalogListOptions): ActionCatalog.ActionCatalogListResult[];
}

export = ActionCatalog;