File Explorer

1/*2 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.3 * SPDX-License-Identifier: Apache-2.0.4 */5 6/**7 *8 * A module containing miscellaneous types for resource management9 *10 * @packageDocumentation11 * @module resource_safety12 * @mergeTarget13 */14 15/**16 * If you have a resource that you want typescript to enforce close is implemented17 * and/or you want to use the below 'using' function, then implement this interface.18 *19 * @category System20 */21export interface ResourceSafe {22    close(): void;23}24 25/**26 * Use this function to create a resource in an async context. This will make sure the27 * resources are cleaned up before returning.28 *29 * Example:30 * ```31 * await using(res = new SomeResource(), async (res) =>  {32 *     res.do_the_thing();33 * });34 * ```35 *36 * @category System37 */38export async function using<T extends ResourceSafe>(resource: T, func: (resource: T) => void) {39    try {40        await func(resource);41    } finally {42        resource.close();43    }44}