Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ResolvedApi

Hierarchy

  • ResolvedApi

Implements

Index

Constructors

constructor

Properties

bookmarks

bookmarks: object

Type declaration

  • [key: string]: string

data

data: ApiData

experiments

experiments: Experiments

httpClient

httpClient: HttpClient

languages

languages: Language[]

masterRef

masterRef: Ref

options

refs

refs: Ref[]

tags

tags: string[]

types

types: object

Type declaration

  • [key: string]: string

Methods

currentExperiment

everything

form

  • Returns a useable form from its id, as described in the RESTful description of the API. For instance: api.form("everything") works on every repository (as "everything" exists by default) You can then chain the calls: api.form("everything").query('[[:d = at(document.id, "UkL0gMuvzYUANCpf")]]').ref(ref).submit()

    Parameters

    • formId: string

    Returns SearchForm | null

getBookmark

getByID

getByIDs

getByUID

getPreviewResolver

  • getPreviewResolver(token: string, documentId?: undefined | string): PreviewResolver

getSingle

master

  • master(): string
  • The ID of the master ref on this prismic.io API. Do not use like this: searchForm.ref(api.master()). Instead, set your ref once in a variable, and call it when you need it; this will allow to change the ref you're viewing easily for your entire page.

    Returns string

previewSession

query

queryFirst

ref

  • ref(label: string): string | null
  • Returns the ref ID for a given ref's label. Do not use like this: searchForm.ref(api.ref("Future release label")). Instead, set your ref once in a variable, and call it when you need it; this will allow to change the ref you're viewing easily for your entire page.

    Parameters

    • label: string

    Returns string | null

Generated using TypeDoc