ui/client/features/story/services/StoriesApi

the client's read of a feature's story.md, backed by GET /api/stories/:feature (ui/server/src/storiesApi.mjs, REST surface landed in 562b69f4).

Cockpit client (features), next. Source: ui/client/features/story/services/StoriesApi.ts.

Interfaces#

StoryCompare#

Defined in: ui/client/features/story/services/StoriesApi.ts:17

Properties#

matched

matched: string[]

Defined in: ui/client/features/story/services/StoriesApi.ts:20

missing

missing: string[]

Defined in: ui/client/features/story/services/StoriesApi.ts:18

undocumented

undocumented: string[]

Defined in: ui/client/features/story/services/StoriesApi.ts:19

---

StoryToolBlock#

Defined in: ui/client/features/story/services/StoriesApi.ts:6

Properties#

acceptance

acceptance: object[]

Defined in: ui/client/features/story/services/StoriesApi.ts:14

id

id: string

text

text: string

blockHash

blockHash: string

Defined in: ui/client/features/story/services/StoriesApi.ts:9

description

description: string

Defined in: ui/client/features/story/services/StoriesApi.ts:12

fetchedAt

fetchedAt: string

Defined in: ui/client/features/story/services/StoriesApi.ts:7

handEdited

handEdited: boolean

Defined in: ui/client/features/story/services/StoriesApi.ts:10

sourceHash

sourceHash: string

Defined in: ui/client/features/story/services/StoriesApi.ts:8

status

status: string

Defined in: ui/client/features/story/services/StoriesApi.ts:13

title

title: string

Defined in: ui/client/features/story/services/StoriesApi.ts:11

Type Aliases#

StoryView#

StoryView = { exists: false; ok: true; } | { compare: StoryCompare; driftHash: string; exists: true; keptOutOfGit: boolean; ok: true; reviewedHash: string | null; sources: unknown[]; tool: StoryToolBlock | null; userText: string; } | { error: string; ok: false; }

Defined in: ui/client/features/story/services/StoriesApi.ts:23

Variables#

StoriesApi#

const StoriesApi: object

Defined in: ui/client/features/story/services/StoriesApi.ts:40

Type Declaration#

get()

get(feature): Promise<StoryView>

The current view of features/<feature>/story.md (or exists:false), never throws.

Parameters

feature

string

Returns

Promise<StoryView>