Class Story

A data story: a narrative built from saved queries and prose paragraphs.

Remarks

Obtain one from an Account with getStory, addStory or ensureStory. Stories are never constructed directly.

Example: Get a story and read the elements it is built from

const story = await account.getStory("my-story");
const { content } = await story.getInfo();

Index

Properties

Methods

delete getContent getInfo setBanner

Properties

slug

slug: string

The story's short name, as it appears in its URL.

Methods

delete

delete(): Promise<void>

Deletes this story.

Returns Promise<void>

Remarks
Destructive and not undoable. The queries it showed are left alone — a story only references them.

getContent

getContent(): Promise<(StoryElementQuery | StoryElementParagraph)[]>

This story's elements in order, with each query element resolved to a Query.

Returns Promise<(StoryElementQuery | StoryElementParagraph)[]>

Remarks
Narrow on each element's type to tell a paragraph from a query. The accounts owning the referenced queries are fetched up front, so this costs requests that Story.getInfo does not.

getInfo

getInfo(refresh?: boolean): Promise<StoryInfo>
This story's metadata, including the raw description of its elements.
Parameters
- refresh: boolean = false
Returns Promise<StoryInfo>

Remarks
Cached after the first call. Pass true to refetch. Use Story.getContent when you want the elements as objects rather than as data.

setBanner

setBanner(
pathBufferOrFile: string | Buffer<ArrayBufferLike> | File,
): Promise<Story>
Replaces the image shown at the top of this story.
Parameters
- pathBufferOrFile: string | Buffer<ArrayBufferLike> | File
  Path to an image file, or its contents.
Returns Promise<Story>