History

Kristiyan Kostadinov 59ef40988e feat(core): support TypeScript 4.2 (#41158 ) Updates the repo to TypeScript 4.2 and tslib 2.1.0. PR Close #41158		2021-03-17 09:10:25 -07:00
..
bin	test(bazel): Build and test ts-api-guardian locally (#22544 )	2018-03-02 15:00:00 -08:00
lib	fix(dev-infra): update type castings for JSON.parse usage (#40710 )	2021-02-09 10:48:43 -08:00
test	build: update license headers to reference Google LLC (#37205 )	2020-05-26 14:26:58 -04:00
BUILD.bazel	feat(dev-infra): make ts-api-guardian compatible with rules_nodejs version 3 (#40353 )	2021-01-11 15:36:29 -08:00
README.md	release: ts_api_guardian (#30120 )	2019-05-13 10:53:34 -07:00
index.bzl	build: update tools directory for latest changes in rules_nodejs (#40710 )	2021-02-09 10:48:43 -08:00
package.json	feat(core): support TypeScript 4.2 (#41158 )	2021-03-17 09:10:25 -07:00

README.md

Typescript API Guardian

Keeps track of public API surface of a typescript library.

Examples:

# Generate one declaration file
ts-api-guardian --out api_guard.d.ts index.d.ts
# Generate multiple declaration files
# (output location like typescript)
ts-api-guardian --outDir api_guard [--rootDir .] core/index.d.ts core/testing.d.ts
# Print usage
ts-api-guardian --help
# Check against one declaration file
ts-api-guardian --verify api_guard.d.ts index.d.ts
# Check against multiple declaration files
ts-api-guardian --verifyDir api_guard [--rootDir .] core/index.d.ts core/testing.d.ts

For developers

Build and test this library:

$ yarn bazel run //:install
$ yarn bazel test //tools/ts-api-guardian:all

Publish to NPM:

$ yarn bazel run @nodejs//:npm whoami # should be logged in as angular
$ grep version tools/ts-api-guardian/package.json # advance as needed
$ yarn bazel run //tools/ts-api-guardian:ts-api-guardian.publish