Interface that allows you to create a component with a method that closes it and frees used resources.
Description
The IClosable interface allows you to create a component with a method that closes it and frees used resources.
Instance methods
close
Closes a component and frees used resources.
close(correlationId: string): Promise<void>
- correlationId: string - (optional) transaction id used to trace execution through the call chain.
Examples
class MyConnector implements IClosable {
private _client: any = null;
... // The _client can be lazy created
public async close(correlationId: string): Promise<void> {
if (this._client != null) {
this._client.close();
this._client = null;
}
}
}