consul/lib/agent/service.d.ts

Consul client

import { CommonOptions, Consul } from "../consul";
import { CheckOptions } from "./check";

interface ListOptions extends CommonOptions {
  filter?: string;
}

type ListResult = Record<string, any>;

interface RegisterConnect {
  native?: boolean;
  proxy?: any;
  sidecarservice: Record<string, any>;
}

interface RegisterOptions extends CommonOptions {
  name: string;
  id?: string;
  tags?: string[];
  address?: string;
  taggedaddresses?: Record<string, any>;
  meta?: Record<string, string>;
  namespace?: string;
  port?: number;
  kind?: string;
  proxy?: any;
  connect?: RegisterConnect;
  check?: CheckOptions;
  checks?: CheckOptions[];
}

type RegisterResult = any;

interface DeregisterOptions extends CommonOptions {
  id: string;
}

type DeregisterResult = any;

interface MaintenanceOptions extends CommonOptions {
  id: string;
  enable: boolean;
  reason?: string;
  ns?: string;
}

type MaintenanceResult = any;

declare class AgentService {
  constructor(consul: Consul);

  consul: Consul;

  list(options?: ListOptions): Promise<ListResult>;

  register(options: RegisterOptions): Promise<RegisterResult>;
  register(name: string): Promise<RegisterResult>;

  deregister(options: DeregisterOptions): Promise<DeregisterResult>;
  deregister(id: string): Promise<DeregisterResult>;

  maintenance(options: MaintenanceOptions): Promise<MaintenanceResult>;
}