PrismicLoader

Convenient loader for Prismic

Kind: global class
Requires: module:'prismic-javascript'
Todo

• [ ] Tests

• PrismicLoader
  • new PrismicLoader(options)
  • .connect([options]) ⇒ Promise.<Object>
  • .fetchAll([options]) ⇒ Promise.<Array>
  • .fetch(options) ⇒ Promise.<Array>
  • .fetchAllAsIndexed([options]) ⇒ Promise.<Object>
  • .fetchAsIndexed(options) ⇒ Promise.<Object>
  • .getPreviewResolver(options) ⇒ Object

new PrismicLoader(options)

| Param | Type | Default | Description | | --- | --- | --- | --- | | options | Object | | | | options.accessToken | string | | The access token used to communicate with the Prismic API (https://user-guides.prismic.io/en/articles/1036153-generating-an-access-token) | | options.apiEndpoint | string | | The Prismic API endpoint for your repository (https://prismic.io/docs/rest-api/basics/introduction-to-the-content-query-api#4_1-the-api-search-endpoint) | | [options.logger] | Object | console | Logger | | [options.linkResolver] | function | | Prismic Link Resolver to use |

Example

import PrismicLoader from 'prismic-loader'

const accessToken = 'PRISMIC ACCESS TOKEN'
const apiEndpoint = 'https://repo.cdn.prismic.io/api/v2'
const prismicLoader = new PrismicLoader({ accessToken, apiEndpoint })

prismicLoader.connect([options]) ⇒ Promise.<Object>

Connect to the Prismic API

Kind: instance method of PrismicLoader
Returns: Promise.<Object> - - Object containing the connected Prismic API instance
Access: public

| Param | Type | Default | Description | | --- | --- | --- | --- | | [options] | Object | {} | | | [options.req] | Object | | The Request object |

prismicLoader.fetchAll([options]) ⇒ Promise.<Array>

Fetch all documents

Kind: instance method of PrismicLoader
Returns: Promise.<Array> - - An array of documents from Prismic
Access: public

| Param | Type | Default | Description | | --- | --- | --- | --- | | [options] | Object | | | | [options.lang] | string | "'*'" | Language to query | | [options.pageSize] | number | 100 | Number of documents to fetch at a time |

prismicLoader.fetch(options) ⇒ Promise.<Array>

Fetch matching Prismic documents

Kind: instance method of PrismicLoader
Returns: Promise.<Array> - - Prismic documents
Access: public

| Param | Type | Description | | --- | --- | --- | | options | Object | | | options.query | string | Prismic query | | options.options | Object | Prismic query options |

prismicLoader.fetchAllAsIndexed([options]) ⇒ Promise.<Object>

Fetch all documents as indexed object

Kind: instance method of PrismicLoader
Returns: Promise.<Object> - - id indexed Prismic documents
Access: public

| Param | Type | Default | Description | | --- | --- | --- | --- | | [options] | Object | | | | [options.lang] | string | "'*'" | Language to query | | [options.pageSize] | number | 100 | Number of documents to fetch at a time |

prismicLoader.fetchAsIndexed(options) ⇒ Promise.<Object>

Fetch documents as indexed object

Kind: instance method of PrismicLoader
Returns: Promise.<Object> - - id indexed Prismic documents
Access: public

| Param | Type | Description | | --- | --- | --- | | options | Object | | | options.query | string | Prismic query | | options.options | Object | Prismic query options |

prismicLoader.getPreviewResolver(options) ⇒ Object

Preview a Prismic document

Kind: instance method of PrismicLoader
Returns: Object - - An escaped Prismic document
Throws:

• Error - Prismic error

Access: public

| Param | Type | Default | Description | | --- | --- | --- | --- | | options | Object | | | | options.token | Object | | Preview token to use | | [options.linkResolver] | function | this.config.linkResolver | Prismic Link Resolver to use |