consul/lib/kv.d.ts

Consul client

import { Consul } from "./consul";

interface GetOptions {
  key?: string;
  dc?: string;
  raw?: boolean;
  keys?: boolean;
  separator?: string;
  ns?: string;
}

interface GetOptionsRecurse extends GetOptions {
  recurse: boolean;
}

interface GetItem {
  CreateIndex: number;
  ModifyIndex: number;
  LockIndex: number;
  Key: string;
  Flags: number;
  Value: string | null;
}

type GetResult = GetItem | null;

type GetResultRecurse = GetItem[] | GetItem | null;

interface KeysOptions extends GetOptions {
  recurse?: boolean;
}

type KeysResult = string[];

interface SetOptions {
  key?: string;
  value: string | Buffer;
  dc?: string;
  flags?: number;
  cas?: number;
  acquire?: string;
  release?: string;
  ns?: string;
}

type SetResult = boolean;

interface DelOptions {
  key?: string;
  dc?: string;
  recurse?: boolean;
  cas?: number;
  ns?: string;
}

type DelResult = boolean;

declare class Kv {
  constructor(consul: Consul);

  consul: Consul;

  get(options?: GetOptions): Promise<GetResult>;
  get(key: string): Promise<GetResult>;
  get(options?: GetOptionsRecurse): Promise<GetResultRecurse>;

  keys(options?: KeysOptions): Promise<KeysResult>;
  keys(key: string): Promise<KeysResult>;

  set(options: SetOptions): Promise<SetResult>;
  set(key: string, value: string | Buffer): Promise<SetResult>;
  set(
    key: string,
    value: string | Buffer,
    options: SetOptions,
  ): Promise<SetResult>;

  del(options: DelOptions): Promise<DelResult>;
  del(key: string): Promise<DelResult>;
}