prismic-javascript

  • Version 3.0.2
  • Published
  • 470 kB
  • 1 dependency
  • Apache-2.0 license

Install

npm i prismic-javascript
yarn add prismic-javascript
pnpm add prismic-javascript

Overview

JavaScript development kit for prismic.io

Index

Variables

variable _default

const _default: {
experimentCookie: string;
previewCookie: string;
Predicates: {
at(
fragment: string,
value:
| string
| number
| boolean
| Date
| (string | number | boolean | Date)[]
): string;
not(
fragment: string,
value:
| string
| number
| boolean
| Date
| (string | number | boolean | Date)[]
): string;
missing(fragment: string): string;
has(fragment: string): string;
any(fragment: string, values: (string | number | boolean | Date)[]): string;
in(fragment: string, values: string[]): string;
fulltext(fragment: string, value: string): string;
similar(documentId: string, maxResults: number): string;
date: {
before(
fragment: string,
before: string | number | boolean | Date
): string;
after(fragment: string, after: string | number | boolean | Date): string;
between(
fragment: string,
before: string | number | boolean | Date,
after: string | number | boolean | Date
): string;
dayOfMonth(fragment: string, day: number): string;
dayOfMonthAfter(fragment: string, day: number): string;
dayOfMonthBefore(fragment: string, day: number): string;
dayOfWeek(fragment: string, day: string | number): string;
dayOfWeekAfter(fragment: string, day: string | number): string;
dayOfWeekBefore(fragment: string, day: string | number): string;
month(fragment: string, month: string | number): string;
monthBefore(fragment: string, month: string | number): string;
monthAfter(fragment: string, month: string | number): string;
year(fragment: string, year: number): string;
hour(fragment: string, hour: number): string;
hourBefore(fragment: string, hour: number): string;
hourAfter(fragment: string, hour: number): string;
};
dateBefore: (
fragment: string,
before: string | number | boolean | Date
) => string;
dateAfter: (
fragment: string,
after: string | number | boolean | Date
) => string;
dateBetween: (
fragment: string,
before: string | number | boolean | Date,
after: string | number | boolean | Date
) => string;
dayOfMonth: (fragment: string, day: number) => string;
dayOfMonthAfter: (fragment: string, day: number) => string;
dayOfMonthBefore: (fragment: string, day: number) => string;
dayOfWeek: (fragment: string, day: string | number) => string;
dayOfWeekAfter: (fragment: string, day: string | number) => string;
dayOfWeekBefore: (fragment: string, day: string | number) => string;
month: (fragment: string, month: string | number) => string;
monthBefore: (fragment: string, month: string | number) => string;
monthAfter: (fragment: string, month: string | number) => string;
year: (fragment: string, year: number) => string;
hour: (fragment: string, hour: number) => string;
hourBefore: (fragment: string, hour: number) => string;
hourAfter: (fragment: string, hour: number) => string;
number: {
gt(fragment: string, value: number): string;
lt(fragment: string, value: number): string;
inRange(fragment: string, before: number, after: number): string;
};
gt: (fragment: string, value: number) => string;
lt: (fragment: string, value: number) => string;
inRange: (fragment: string, before: number, after: number) => string;
near: (
fragment: string,
latitude: number,
longitude: number,
radius: number
) => string;
geopoint: {
near(
fragment: string,
latitude: number,
longitude: number,
radius: number
): string;
};
};
Experiments: typeof Experiments;
Api: typeof Api;
client: typeof client;
getApi: typeof getApi;
api: typeof api;
};

    Functions

    function api

    api: (url: string, options?: ApiOptions) => Promise<ResolvedApi>;

      function client

      client: (url: string, options?: ApiOptions) => DefaultClient;

        function getApi

        getApi: (url: string, options?: ApiOptions) => Promise<ResolvedApi>;

          Package Files (1)

          Dependencies (1)

          Dev Dependencies (12)

          Peer Dependencies (0)

          No peer dependencies.

          Badge

          To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

          You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/prismic-javascript.

          • Markdown
            [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/prismic-javascript)
          • HTML
            <a href="https://www.jsdocs.io/package/prismic-javascript"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>