ui/client/features/story/services/StoryBridgeApi

the two-step "propose a diff, review, then save" client calls for story.md's sources list, backed by ui/server/src/storyBridgeApi.mjs.

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

Type Aliases#

StoryDiffResult#

StoryDiffResult = { after: string; before: string; changed: boolean; ok: true; } | { error: string; ok: false; }

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

---

StorySaveResult#

StorySaveResult = { autoCommit?: unknown; changed: boolean; ok: true; } | { error: string; ok: false; }

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

Variables#

StoryBridgeApi#

const StoryBridgeApi: object

Defined in: ui/client/features/story/services/StoryBridgeApi.ts:28

Type Declaration#

preview()

preview(input): Promise<StoryDiffResult>

Parameters

input

feature

string

parse

Record<string, StorySelector>

url

string

Returns

Promise<StoryDiffResult>

save()

save(input): Promise<StorySaveResult>

Parameters

input

feature

string

parse

Record<string, StorySelector>

url

string

Returns

Promise<StorySaveResult>

valuesPreview()

valuesPreview(input): Promise<StoryDiffResult>

Parameters

input

feature

string

url

string

values

Record<string, string | string[]>

Returns

Promise<StoryDiffResult>

valuesSave()

valuesSave(input): Promise<StorySaveResult>

Parameters

input

feature

string

url

string

values

Record<string, string | string[]>

Returns

Promise<StorySaveResult>