Add TypeScript declarations for admin-api #586
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Add first-party TypeScript declarations for
@tryghost/admin-api
and type tests.Checklist
yarn test
andyarn lint
)Changes
packages/admin-api/index.d.ts
covering API resources: posts, pages, tags, members, users, newsletters, webhooks, uploads, config, site, themes.types: "index.d.ts"
and include infiles
inpackages/admin-api/package.json
.packages/admin-api/test/types
:tsconfig.json
(self-contained)types.test.ts
using inline generic assertions sotsc
enforces types without extra libs.test:types
script and wire it in CI if desired (currently separate).Usage example
Screenshots