Interface IConnection

interface IConnection {
    delete: ((path, payload, expectReturnContent?) => Promise<any>);
    get: (<T>(path, expectReturnContent?) => Promise<T>);
    head: ((path, payload) => Promise<boolean>);
    patch: ((path, payload) => Promise<any>);
    postEmpty: (<B>(path, payload) => Promise<void>);
    postReturn: (<B, T>(path, payload) => Promise<T>);
    put: ((path, payload, expectReturnContent?) => Promise<any>);
    getDetails(): Promise<ConnectionDetails>;
    login(): Promise<string>;
}

Implemented by

Properties

delete get head patch postEmpty postReturn put

Methods

getDetails login

Properties

delete

delete: ((path, payload, expectReturnContent?) => Promise<any>)

Type declaration

    • (path, payload, expectReturnContent?): Promise<any>

    • Parameters

      • path: string
      • payload: any
      • Optional expectReturnContent: boolean

      Returns Promise<any>

get

get: (<T>(path, expectReturnContent?) => Promise<T>)

Type declaration

    • <T>(path, expectReturnContent?): Promise<T>

    • Type Parameters

      • T

      Parameters

      • path: string
      • Optional expectReturnContent: boolean

      Returns Promise<T>

head

head: ((path, payload) => Promise<boolean>)

Type declaration

    • (path, payload): Promise<boolean>

    • Parameters

      • path: string
      • payload: any

      Returns Promise<boolean>

patch

patch: ((path, payload) => Promise<any>)

Type declaration

    • (path, payload): Promise<any>

    • Parameters

      • path: string
      • payload: any

      Returns Promise<any>

postEmpty

postEmpty: (<B>(path, payload) => Promise<void>)

Type declaration

    • <B>(path, payload): Promise<void>

    • Type Parameters

      • B

      Parameters

      • path: string
      • payload: B

      Returns Promise<void>

postReturn

postReturn: (<B, T>(path, payload) => Promise<T>)

Type declaration

    • <B, T>(path, payload): Promise<T>

    • Type Parameters

      • B
      • T

      Parameters

      • path: string
      • payload: B

      Returns Promise<T>

put

put: ((path, payload, expectReturnContent?) => Promise<any>)

Type declaration

    • (path, payload, expectReturnContent?): Promise<any>

    • Parameters

      • path: string
      • payload: any
      • Optional expectReturnContent: boolean

      Returns Promise<any>

Methods

getDetails

  • getDetails(): Promise<ConnectionDetails>

  • Returns Promise<ConnectionDetails>

login

Settings

Member Visibility

Theme

On This Page

deletegetheadpatchpostEmptypostReturnputgetDetailslogin