Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prismicio/prismic-types
Type definitions for Prismic content, models, and APIs
https://github.com/prismicio/prismic-types
javascript prismic typescript
Last synced: about 2 months ago
JSON representation
Type definitions for Prismic content, models, and APIs
- Host: GitHub
- URL: https://github.com/prismicio/prismic-types
- Owner: prismicio
- License: apache-2.0
- Created: 2021-05-06T13:12:15.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-06-06T19:38:43.000Z (over 1 year ago)
- Last Synced: 2024-05-22T21:21:05.757Z (4 months ago)
- Topics: javascript, prismic, typescript
- Language: TypeScript
- Homepage: https://prismic.io/docs/technologies/javascript
- Size: 1.64 MB
- Stars: 11
- Watchers: 7
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-prismic - @prismicio/types - Type definitions for Prismic related structure. (Ecosystem / Development Kits)
- awesome-list - prismic-types
README
> **Note**: **This package has been merged into [`@prismicio/client`](https://github.com/prismicio/prismic-client) ≥ v7.**
>
> This package and repository will no longer be updated, except in special circumstances.
# @prismicio/types
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]
[![Codecov][codecov-src]][codecov-href]
[![Conventional Commits][conventional-commits-src]][conventional-commits-href]
[![License][license-src]][license-href]
> ⚠ This project is in an experimental state and therefore primarily meant to be used by Prismic kits. Use it at your own risks or stay tuned for the official release!
Type definitions for [Prismic][prismic] related structure.
- 📄 Per-field type definitions;
- 🌐 Dedicated GraphQL API support.
## Install
```bash
npm install --save-dev @prismicio/types
```
## Documentation
To discover what's new on this package check out [the changelog][changelog]. For full documentation, visit the [official Prismic documentation][prismic-docs].
## Contributing
Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of the Prismic developer community!
**Asking a question**: [Open a new topic][forum-question] on our community forum explaining what you want to achieve / your question. Our support team will get back to you shortly.
**Reporting a bug**: [Open an issue][repo-bug-report] explaining your application's setup and the bug you're encountering.
**Suggesting an improvement**: [Open an issue][repo-feature-request] explaining your improvement or feature so we can discuss and learn more.
**Submitting code changes**: For small fixes, feel free to [open a pull request][repo-pull-requests] with a description of your changes. For large changes, please first [open an issue][repo-feature-request] so we can discuss if and how the changes should be implemented.
For more clarity on this project and its structure you can also check out the detailed [CONTRIBUTING.md][contributing] document.
## License
```
Copyright 2013-2022 Prismic (https://prismic.io)
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```
[prismic]: https://prismic.io
[prismic-docs]: https://prismic.io/docs/technologies/javascript
[changelog]: ./CHANGELOG.md
[contributing]: ./CONTRIBUTING.md
[forum-question]: https://community.prismic.io/c/kits-and-dev-languages/javascript/14
[repo-bug-report]: https://github.com/prismicio/prismic-types/issues/new?assignees=&labels=bug&template=bug_report.md&title=
[repo-feature-request]: https://github.com/prismicio/prismic-types/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=
[repo-pull-requests]: https://github.com/prismicio/prismic-types/pulls
[npm-version-src]: https://img.shields.io/npm/v/@prismicio/types/latest.svg
[npm-version-href]: https://npmjs.com/package/@prismicio/types
[npm-downloads-src]: https://img.shields.io/npm/dm/@prismicio/types.svg
[npm-downloads-href]: https://npmjs.com/package/@prismicio/types
[github-actions-ci-src]: https://github.com/prismicio/prismic-types/workflows/ci/badge.svg
[github-actions-ci-href]: https://github.com/prismicio/prismic-types/actions?query=workflow%3Aci
[codecov-src]: https://img.shields.io/codecov/c/github/prismicio/prismic-types.svg
[codecov-href]: https://codecov.io/gh/prismicio/prismic-types
[conventional-commits-src]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg
[conventional-commits-href]: https://conventionalcommits.org
[license-src]: https://img.shields.io/npm/l/@prismicio/types.svg
[license-href]: https://npmjs.com/package/@prismicio/types