Skip to main content

@wildix/xbees-users-client > UsersClient

UsersClient class

Signature:

export declare class UsersClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig> 

Extends: __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig>

Constructors

Constructor

Modifiers

Description

(constructor)([configuration])

Constructs a new instance of the UsersClient class

Properties

Property

Modifiers

Type

Description

config

readonly

UsersClientResolvedConfig

The resolved configuration of UsersClient class. This is resolved and normalized from the constructor configuration interface.

Methods

Method

Modifiers

Description

destroy()

Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.