Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Rule proposal: require-using to force using using with disposable #8255

Open
@nicolo-ribaudo

Description

@nicolo-ribaudo

Before You File a Proposal Please Confirm You Have Done The Following...

My proposal is suitable for this project

  • My proposal specifically checks TypeScript syntax, or it proposes a check that requires type information to be accurate.
  • My proposal is not a "formatting rule"; meaning it does not just enforce how code is formatted (whitespace, brace placement, etc).
  • I believe my proposal would be useful to the broader TypeScript community (meaning it is not a niche proposal).

Description

TypeScript now supports Disposables: objects that have some "dispose" behavior when they go out of scope.

It's important to use using and not const/let when using those objects, otherwise the automatic cleanup does not happen and you would leak resources.

Fail Cases

In this case we are opening a file through an API that expects to be disposed, but we are not using it as such. The readConfig function will thus leak resources associated to the opened file.

declare function openFile(url: string): Disposable & MyFileAPI;

function readConfig() {
  const configFile = openFile("./configFile");
  return configFile.contentsAsJson();
}

Pass Cases

In this case we are properly disposing the file resource.

declare function openFile(url: string): Disposable & MyFileAPI;

function readConfig() {
  using configFile = openFile("./configFile");
  return configFile.contentsAsJson();
}

Additional Info

This is the equivalent to require-await, but for Disposables rather than Thenables.

Metadata

Metadata

Assignees

No one assigned

    Labels

    accepting prsGo ahead, send a pull request that resolves this issueenhancement: new plugin ruleNew rule request for eslint-pluginpackage: eslint-pluginIssues related to @typescript-eslint/eslint-plugin

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions