prismic-javascript

Index

Modules

Prismic

Classes

Type aliases

Variables

Functions

Object literals

Type aliases

Fields

Fields: object

Type declaration

[key: string]: any

LinkResolver

LinkResolver: function

Type declaration

- (doc: any): string
- Parameters
  - doc: any
  Returns string

PredicateValue

PredicateValue: boolean | string | number | Date

RequestCallback

RequestCallback: function

Type declaration

- (error: Error | null, result?: T | null, resp?: Response, ttl?: undefined | number): void
- Parameters
  - error: Error | null
  - Optional result: T | null
  - Optional resp: Response
  - Optional ttl: undefined | number
  Returns void

Variables

Const EXPERIMENT_COOKIE

EXPERIMENT_COOKIE: "io.prismic.experiment" = "io.prismic.experiment"

Const PREVIEW_COOKIE

PREVIEW_COOKIE: "io.prismic.preview" = "io.prismic.preview"

decode

decode: decodeURIComponent = decodeURIComponent

Functions

LRUCache

LRUCache(limit: number): void

- Defined in lru.ts:31
Parameters
- limit: number
Returns void

MakeLRUCache

MakeLRUCache(limit: number): ILRUCache

- Defined in lru.ts:20
A doubly linked list-based Least Recently Used (LRU) cache. Will keep most recently used items while discarding least recently used items when its limit is reached.

Licensed under MIT. Copyright (c) 2010 Rasmus Andersson http://hunch.se/ Typescript-ified by Oleksandr Nikitin https://tvori.info

Illustration of the design:
```
  entry             entry             entry             entry
  ______            ______            ______            ______
 | head |.newer => |      |.newer => |      |.newer => | tail |
 |  A   |          |  B   |          |  C   |          |  D   |
 |______| <= older.|______| <= older.|______| <= older.|______|
```
removed <-- <-- <-- <-- <-- <-- <-- <-- <-- <-- <-- added
Parameters
- limit: number
Returns ILRUCache

createPreviewResolver

createPreviewResolver(token: string, documentId?: undefined | string, getDocByID?: undefined | function): PreviewResolver

- Defined in PreviewResolver.ts:12
Parameters
- token: string
- Optional documentId: undefined | string
- Optional getDocByID: undefined | function
Returns PreviewResolver

encode

encode(value: PredicateValue | PredicateValue[]): string

- Defined in Predicates.ts:34
Parameters
- value: PredicateValue | PredicateValue[]
Returns string

fetchRequest

fetchRequest<T>(url: string, options: RequestHandlerOption, callback: RequestCallback<T>): void

- Defined in request.ts:5
Type parameters
- T
Parameters
- url: string
- options: RequestHandlerOption
- callback: RequestCallback<T>
Returns void

parse

parse(str: string, options?: any): Cookie

- Defined in Cookies.ts:18
Parameters
- str: string
- Optional options: any
Returns Cookie

separator

separator(url: string): "?" | "&"

- Defined in Api.ts:19
Parameters
- url: string
Returns "?" | "&"

tryDecode

tryDecode(str: string, decode: function): string

- Defined in Cookies.ts:10
Parameters
- str: string
- decode: function
  - - (str: string): string
    - Parameters
      - str: string
      Returns string
Returns string

Object literals

Const OPERATOR

OPERATOR: object

GeopointNear

GeopointNear: string = "geopoint.near"

any

any: string = "any"

at

at: string = "at"

dateAfter

dateAfter: string = "date.after"

dateBefore

dateBefore: string = "date.before"

dateBetween

dateBetween: string = "date.between"

dateDayOfMonth

dateDayOfMonth: string = "date.day-of-month"

dateDayOfMonthAfter

dateDayOfMonthAfter: string = "date.day-of-month-after"

dateDayOfMonthBefore

dateDayOfMonthBefore: string = "date.day-of-month-before"

dateDayOfWeek

dateDayOfWeek: string = "date.day-of-week"

dateDayOfWeekAfter

dateDayOfWeekAfter: string = "date.day-of-week-after"

dateDayOfWeekBefore

dateDayOfWeekBefore: string = "date.day-of-week-before"

dateHour

dateHour: string = "date.hour"

dateHourAfter

dateHourAfter: string = "date.hour-after"

dateHourBefore

dateHourBefore: string = "date.hour-before"

dateMonth

dateMonth: string = "date.month"

dateMonthAfter

dateMonthAfter: string = "date.month-after"

dateMonthBefore

dateMonthBefore: string = "date.month-before"

dateYear

dateYear: string = "date.year"

fulltext

fulltext: string = "fulltext"

has

has: string = "has"

in

in: string = "in"

missing

missing: string = "missing"

not

not: string = "not"

numberGt

numberGt: string = "number.gt"

numberInRange

numberInRange: string = "number.inRange"

numberLt

numberLt: string = "number.lt"

similar

similar: string = "similar"

Const date

date: object

after

after(fragment: string, after: PredicateValue): string

- Defined in Predicates.ts:62
Parameters
- fragment: string
- after: PredicateValue
Returns string

before

before(fragment: string, before: PredicateValue): string

- Defined in Predicates.ts:58
Parameters
- fragment: string
- before: PredicateValue
Returns string

between

between(fragment: string, before: PredicateValue, after: PredicateValue): string

- Defined in Predicates.ts:66
Parameters
- fragment: string
- before: PredicateValue
- after: PredicateValue
Returns string

dayOfMonth

dayOfMonth(fragment: string, day: number): string

- Defined in Predicates.ts:70
Parameters
- fragment: string
- day: number
Returns string

dayOfMonthAfter

dayOfMonthAfter(fragment: string, day: number): string

- Defined in Predicates.ts:74
Parameters
- fragment: string
- day: number
Returns string

dayOfMonthBefore

dayOfMonthBefore(fragment: string, day: number): string

- Defined in Predicates.ts:78
Parameters
- fragment: string
- day: number
Returns string

dayOfWeek

dayOfWeek(fragment: string, day: number | string): string

- Defined in Predicates.ts:82
Parameters
- fragment: string
- day: number | string
Returns string

dayOfWeekAfter

dayOfWeekAfter(fragment: string, day: number | string): string

- Defined in Predicates.ts:86
Parameters
- fragment: string
- day: number | string
Returns string

dayOfWeekBefore

dayOfWeekBefore(fragment: string, day: number | string): string

- Defined in Predicates.ts:90
Parameters
- fragment: string
- day: number | string
Returns string

hour

hour(fragment: string, hour: number): string

- Defined in Predicates.ts:110
Parameters
- fragment: string
- hour: number
Returns string

hourAfter

hourAfter(fragment: string, hour: number): string

- Defined in Predicates.ts:118
Parameters
- fragment: string
- hour: number
Returns string

hourBefore

hourBefore(fragment: string, hour: number): string

- Defined in Predicates.ts:114
Parameters
- fragment: string
- hour: number
Returns string

month

month(fragment: string, month: number | string): string

- Defined in Predicates.ts:94
Parameters
- fragment: string
- month: number | string
Returns string

monthAfter

monthAfter(fragment: string, month: number | string): string

- Defined in Predicates.ts:102
Parameters
- fragment: string
- month: number | string
Returns string

monthBefore

monthBefore(fragment: string, month: number | string): string

- Defined in Predicates.ts:98
Parameters
- fragment: string
- month: number | string
Returns string

year

year(fragment: string, year: number): string

- Defined in Predicates.ts:106
Parameters
- fragment: string
- year: number
Returns string

Const geopoint

geopoint: object

near

near(fragment: string, latitude: number, longitude: number, radius: number): string

- Defined in Predicates.ts:51
Parameters
- fragment: string
- latitude: number
- longitude: number
- radius: number
Returns string

Const number

number: object

gt

gt(fragment: string, value: number): string

- Defined in Predicates.ts:124
Parameters
- fragment: string
- value: number
Returns string

inRange

inRange(fragment: string, before: number, after: number): string

- Defined in Predicates.ts:132
Parameters
- fragment: string
- before: number
- after: number
Returns string

lt

lt(fragment: string, value: number): string

- Defined in Predicates.ts:128
Parameters
- fragment: string
- value: number
Returns string

Index

Modules

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

Fields

Type declaration

[key: string]: any

LinkResolver

Type declaration

Parameters

doc: any

Returns string

PredicateValue

RequestCallback

Type declaration

Parameters

error: Error | null

Optional result: T | null

Optional resp: Response

Optional ttl: undefined | number

Returns void

Variables

Const EXPERIMENT_COOKIE

Const PREVIEW_COOKIE

decode

Functions

LRUCache

Parameters

limit: number

Returns void

MakeLRUCache

Parameters

limit: number

Returns ILRUCache

createPreviewResolver

Parameters

token: string

Optional documentId: undefined | string

Optional getDocByID: undefined | function

Returns PreviewResolver

encode

Parameters

value: PredicateValue | PredicateValue[]

Returns string

fetchRequest

Type parameters

T

Parameters

url: string

options: RequestHandlerOption

callback: RequestCallback<T>

Returns void

parse

Parameters

str: string

Optional options: any

Returns Cookie

separator

Parameters

url: string

Returns "?" | "&"

tryDecode

Parameters

str: string

decode: function

Parameters

str: string

Returns string

Returns string

Object literals

Const OPERATOR

GeopointNear

any

at

dateAfter