Interface StoryConfig

interface StoryConfig {
    name: string;
    rngsIo: string;
    syncPath: string;
    preview?: LiveEndpoint;
    public?: LiveEndpoint;
}

Index

Properties

name rngsIo syncPath preview? public?

Properties

name

name: string

The name of the story in RNGS.io

Note: This is updated each time you run the CLI but may be out of sync with recent changes in RNGS.io.

rngsIo

rngsIo: string

The link to the story in RNGS.io

syncPath

syncPath: string

The local path to a file the story is synced to, relative to the root of the project

`Optional` preview

preview?: LiveEndpoint

A ⚡LIVE endpoint preview version of the story

`Optional` public

public?: LiveEndpoint

A ⚡LIVE endpoint public version of the story

Generated using TypeDoc