Class Middleware

Hierarchy

ApiConnection
- Middleware

Index

Constructors

Properties

_jwt _onAuthFailed? _requestFunc? bitcoin lightning liquid pages

Accessors

jwt onAuthFailed requestFunc

Methods

_request delete get isOnline ping post put

Constructors

constructor

new Middleware(baseUrl: string): Middleware
Parameters
- baseUrl: string
Returns Middleware
Overrides ApiConnection.constructor
- Defined in middleware/index.ts:13

Properties

`Protected` _jwt

_jwt: string = ''

`Protected` `Optional` _onAuthFailed

_onAuthFailed?: ((url: string) => void)

Type declaration

- (url: string): void
- Callback to run when a request returns status 401 (optional)
  Parameters
  - url: string
  Returns void

`Protected` `Optional` _requestFunc

_requestFunc?: RequestFunction

Custom request function (optional)

`Readonly` bitcoin

bitcoin: MiddlewareBitcoin

`Readonly` lightning

lightning: MiddlewareLND

`Readonly` liquid

liquid: MiddlewareLiquid

`Readonly` pages

pages: MiddlewarePages

Accessors

jwt

set jwt(newJwt: string): void
Parameters
- newJwt: string
Returns void
Overrides ApiConnection.jwt
- Defined in middleware/index.ts:47

onAuthFailed

set onAuthFailed(callback: ((url: string) => void)): void
Parameters
- callback: ((url: string) => void)
  - - (url: string): void
    - Parameters
      
      url: string
      
      Returns void
Returns void
Overrides ApiConnection.onAuthFailed
- Defined in middleware/index.ts:65

requestFunc

set requestFunc(requestFunc: RequestFunction): void
Parameters
- requestFunc: RequestFunction
Returns void
Overrides ApiConnection.requestFunc
- Defined in middleware/index.ts:56

Methods

_request

_request<ResponseType>(url: string, method?: "GET" | "POST" | "PUT" | "DELETE", body?: unknown, auth?: boolean, blob?: boolean): Promise<ResponseType>
Type Parameters
- ResponseType = unknown
Parameters
- url: string
- method: "GET" | "POST" | "PUT" | "DELETE" = 'GET'
- body: unknown = {}
- auth: boolean = true
- blob: boolean = false
Returns Promise<ResponseType>
Inherited from ApiConnection._request
- Defined in common/connection.ts:33

`Protected` delete

delete<ResponseType>(url: string, body?: unknown, auth?: boolean, blob?: boolean): Promise<ResponseType>
Type Parameters
- ResponseType = unknown
Parameters
- url: string
- body: unknown = {}
- auth: boolean = true
- blob: boolean = false
Returns Promise<ResponseType>
Inherited from ApiConnection.delete
- Defined in common/connection.ts:125

`Protected` get

get<ResponseType>(url: string, auth?: boolean, blob?: boolean): Promise<ResponseType>
Type Parameters
- ResponseType = unknown
Parameters
- url: string
- auth: boolean = true
- blob: boolean = false
Returns Promise<ResponseType>
Inherited from ApiConnection.get
- Defined in common/connection.ts:99

isOnline

isOnline(): Promise<boolean>
Returns Promise<boolean>
- Defined in middleware/index.ts:38

ping

ping(): Promise<{ features?: string[]; isCitadel?: true; version: string }>
Ping a node and get version information

Returns
Version information about the node

Returns Promise<{ features?: string[]; isCitadel?: true; version: string }>
- Defined in middleware/index.ts:26

`Protected` post

post<ResponseType>(url: string, body?: unknown, auth?: boolean, blob?: boolean): Promise<ResponseType>
Type Parameters
- ResponseType = unknown
Parameters
- url: string
- body: unknown = {}
- auth: boolean = true
- blob: boolean = false
Returns Promise<ResponseType>
Inherited from ApiConnection.post
- Defined in common/connection.ts:107

`Protected` put

put<ResponseType>(url: string, body?: unknown, auth?: boolean, blob?: boolean): Promise<ResponseType>
Type Parameters
- ResponseType = unknown
Parameters
- url: string
- body: unknown = {}
- auth: boolean = true
- blob: boolean = false
Returns Promise<ResponseType>
Inherited from ApiConnection.put
- Defined in common/connection.ts:116

Generated using TypeDoc