An open API service indexing awesome lists of open source software.

https://github.com/joshuakgoldberg/ts-api-utils

Utility functions for working with TypeScript's API. Successor to the wonderful tsutils. ๐Ÿ› ๏ธ๏ธ
https://github.com/joshuakgoldberg/ts-api-utils

abstract-syntax-trees tsutils typescript typescript-api

Last synced: 2 months ago
JSON representation

Utility functions for working with TypeScript's API. Successor to the wonderful tsutils. ๐Ÿ› ๏ธ๏ธ

Awesome Lists containing this project

README

          

TypeScript API Utils


Utility functions for working with TypeScript's API.
Successor to the wonderful tsutils.
๐Ÿ› ๏ธ๏ธ


๐Ÿค Code of Conduct: Kept
๐Ÿงช Coverage
๐Ÿ“š Documentation Coverage
๐Ÿ“ License: MIT
๐Ÿ“ฆ npm version
๐Ÿ’ช TypeScript: Strict

## Usage

```shell
npm i ts-api-utils
```

```ts
import * as tsutils from "ts-api-utils";

tsutils.forEachToken(/* ... */);
```

### API

`ts-api-utils` provides many utility functions.
Check out our API docs for details:

๐Ÿ“ [ts-api-utils API docs](https://joshuakgoldberg.github.io/ts-api-utils).

### Supported Versions

`ts-api-utils` supports TypeScript versions `5.5.2` and above and Node versions `20.19.0` and above.

Note: `ts-api-utils` will not work with the TypeScript Native Preview (TypeScript 7) for the foreseeable future, due to
unknowns around the future of the TypeScript Native API.\
See their list of [What Works So Far?](https://github.com/microsoft/typescript-go#what-works-so-far) for details.

## Development

See [`.github/CONTRIBUTING.md`](./.github/CONTRIBUTING.md).
Thanks! ๐Ÿ’–