@prismicio/custom-types-client/README.md

JavaScript client to interact with the Prismic Custom Types API

# @prismicio/custom-types-client

[![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]

<!-- TODO: Replacing link to Prismic with [Prismic][prismic] is useful here -->

JavaScript client to interact with the [Prismic Custom Types API][prismic-custom-types-api].

- 🎣 &nbsp;Fetch Custom Type and Shared Slice models
- 🛠 &nbsp;Insert, update, and delete models

## Install

```bash
npm install @prismicio/custom-types-client @prismicio/client
```

## 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, check out the detailed [CONTRIBUTING.md][contributing] document.

## License

```
Copyright 2013-2024 Prismic <contact@prismic.io> (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.
```

<!-- Links -->

[prismic]: https://prismic.io
[prismic-custom-types-api]: https://prismic.io/docs/technologies/custom-types-api

<!-- TODO: Replace link with a more useful one if available -->

[prismic-docs]: https://prismic.io/docs
[changelog]: ./CHANGELOG.md
[contributing]: ./CONTRIBUTING.md

<!-- TODO: Replace link with a more useful one if available -->

[forum-question]: https://community.prismic.io
[repo-bug-report]: https://github.com/prismicio/prismic-custom-types-client/issues/new?assignees=&labels=bug&template=bug_report.md&title=
[repo-feature-request]: https://github.com/prismicio/prismic-custom-types-client/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=
[repo-pull-requests]: https://github.com/prismicio/prismic-custom-types-client/pulls

<!-- Badges -->

[npm-version-src]: https://img.shields.io/npm/v/@prismicio/custom-types-client/latest.svg
[npm-version-href]: https://npmjs.com/package/@prismicio/custom-types-client
[npm-downloads-src]: https://img.shields.io/npm/dm/@prismicio/custom-types-client.svg
[npm-downloads-href]: https://npmjs.com/package/@prismicio/custom-types-client
[github-actions-ci-src]: https://github.com/prismicio/prismic-custom-types-client/workflows/ci/badge.svg
[github-actions-ci-href]: https://github.com/prismicio/prismic-custom-types-client/actions?query=workflow%3Aci
[codecov-src]: https://img.shields.io/codecov/c/github/prismicio/prismic-custom-types-client.svg
[codecov-href]: https://codecov.io/gh/prismicio/prismic-custom-types-client
[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/custom-types-client.svg
[license-href]: https://npmjs.com/package/@prismicio/custom-types-client