Function toggleLiveEndpoints

toggleLiveEndpoints(storyId, version, enable?): Promise<void>

Turn on or off live endpoints for stories, which are hosted data files that can be used to set page content client-side and republished directly from RNGS.io.

Note: This feature only sets StoryClientConfig values in your project's rngs-io.json file. Your page builder or app must be configured to handle those settings to connect your pages to RNGS.io live endpoints.

CLI

Usage
  $ rngs-io stories live
  $ rngs-io stories live:on [version] [options]
  $ rngs-io stories live:off [version] [options]

Options
  --id          Story ID (a.k.a., "copy key") to turn on/off live endpoints
  -h, --help    Displays this message

Examples
  $ rngs-io stories live
  $ rngs-io stories live public
  $ rngs-io stories live preview --id <story_id>
  $ rngs-io stories live:on
  $ rngs-io stories live:on public
  $ rngs-io stories live:on preview --id <story_id>
  $ rngs-io stories live:off
  $ rngs-io stories live:off public
  $ rngs-io stories live:off preview --id <story_id>

Parameters

storyId: undefined | string
version: undefined | LiveEndpointsVersion
enable: undefined | boolean = undefined

Function toggleLiveEndpoints

CLI

Parameters

storyId: undefined | string

version: undefined | LiveEndpointsVersion

enable: undefined | boolean = undefined

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page