Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prismicio/prismic-helpers
Set of helpers to manage Prismic data
https://github.com/prismicio/prismic-helpers
javascript prismic typescript
Last synced: about 2 months ago
JSON representation
Set of helpers to manage Prismic data
- Host: GitHub
- URL: https://github.com/prismicio/prismic-helpers
- Owner: prismicio
- License: apache-2.0
- Created: 2017-07-26T15:25:38.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-07-18T23:10:07.000Z (about 1 year ago)
- Last Synced: 2024-07-23T15:25:33.586Z (2 months ago)
- Topics: javascript, prismic, typescript
- Language: TypeScript
- Homepage: https://prismic.io/docs/technical-reference/prismicio-helpers
- Size: 1.33 MB
- Stars: 15
- Watchers: 18
- Forks: 9
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-prismic - @prismicio/helpers - JavaScript templating helpers. (Ecosystem / Development Kits)
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/helpers
[![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]
Set of helpers to manage [Prismic][prismic] data.
- 📅 Transform Date and Timestamp fields into Date objects;
- 🗺 Resolve any kind of Link fields;
- 🌐 Dedicated GraphQL API support.
## Install
```bash
npm install @prismicio/helpers
```
## 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/technical-reference/prismicio-helpers
[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-helpers/issues/new?assignees=&labels=bug&template=bug_report.md&title=
[repo-feature-request]: https://github.com/prismicio/prismic-helpers/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=
[repo-pull-requests]: https://github.com/prismicio/prismic-helpers/pulls
[npm-version-src]: https://img.shields.io/npm/v/@prismicio/helpers/latest.svg
[npm-version-href]: https://npmjs.com/package/@prismicio/helpers
[npm-downloads-src]: https://img.shields.io/npm/dm/@prismicio/helpers.svg
[npm-downloads-href]: https://npmjs.com/package/@prismicio/helpers
[github-actions-ci-src]: https://github.com/prismicio/prismic-helpers/workflows/ci/badge.svg
[github-actions-ci-href]: https://github.com/prismicio/prismic-helpers/actions?query=workflow%3Aci
[codecov-src]: https://img.shields.io/codecov/c/github/prismicio/prismic-helpers.svg
[codecov-href]: https://codecov.io/gh/prismicio/prismic-helpers
[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/helpers.svg
[license-href]: https://npmjs.com/package/@prismicio/helpers