aws-crt
Version:
NodeJS/browser bindings to the aws-c-* libraries
30 lines (29 loc) • 806 B
TypeScript
/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
/**
* If you have a resource that you want typescript to enforce close is implemented
* and/or you want to use the below 'using' function, then implement this interface.
*
* @module aws-crt
* @category System
*/
export interface ResourceSafe {
close(): void;
}
/**
* Use this function to create a resource in an async context. This will make sure the
* resources are cleaned up before returning.
*
* Example:
* ```
* await using(res = new SomeResource(), async (res) => {
* res.do_the_thing();
* });
* ```
*
* @module aws-crt
* @category System
*/
export declare function using<T extends ResourceSafe>(resource: T, func: (resource: T) => void): Promise<void>;