Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "clients"

Index

Interfaces

Functions

Functions

createClient

  • Creates a new client.

    Parameters

    Returns Promise<Client>

    The promise with the new client.

deleteClient

  • deleteClient(id: string): Promise<boolean>

  • Tries to delete a client by ID.

    Parameters

    • id: string

      The ID of the client.

    Returns Promise<boolean>

    The promise that indicates if operation was successful or not (client not found).

getClient

  • getClient(id: string): Promise<Client | false>

  • Tries to return a client by ID.

    Parameters

    • id: string

      The ID of the client.

    Returns Promise<Client | false>

    The promise with the client or (false), if not found.

getClients

  • getClients(): Promise<Client[]>

  • Returns a list of all clients.

    Returns Promise<Client[]>

    The promise with the list of clients.

Generated using TypeDoc