ConnectionPromises.Function.close

tedious-plus / ConnectionPromises / close

Function: close()

function close(connection): Promise<void>;

Defined in: ConnectionPromises.ts:221

Closes a connection.

This is the promisified version of Connection.close(). A request that is still active on the connection is completed by Tedious with an error.

Connection errors are ignored. The returned promise is always resolved, even if the connection has failed before.

Parameters

connection

Connection

The Tedious connection to be closed.

Returns

Promise<void>

A promise that is resolved when the connection has ended. If the connection is already closed, the promise is resolved immediately.