OpenPRA Documentation

backends-web-backend

Interface: WorkbookElementAdapter ​

Defined in: backends/web-backend/src/workbooks/workbook-element-registry.ts:9

Properties ​

elementCode ​

readonly elementCode: string

Defined in: backends/web-backend/src/workbooks/workbook-element-registry.ts:10

Methods ​

createBlank() ​

createBlank(workbookId, projectId, name, ownerUsername): Promise<void>

Defined in: backends/web-backend/src/workbooks/workbook-element-registry.ts:11

Parameters ​

workbookId ​

string

projectId ​

string

name ​

string

ownerUsername ​

string

Returns ​

Promise<void>

exampleVariants()? ​

optional exampleVariants(): WorkbookExampleVariant[]

Defined in: backends/web-backend/src/workbooks/workbook-element-registry.ts:15

Returns ​

WorkbookExampleVariant[]

load() ​

load(workbookId): Promise<{ mef: unknown; ownerUsername: string; projectId: string; } | null>

Defined in: backends/web-backend/src/workbooks/workbook-element-registry.ts:12

Parameters ​

workbookId ​

string

Returns ​

Promise<{ mef: unknown; ownerUsername: string; projectId: string; } | null>

loadExample()? ​

optional loadExample(workbookId, acting, exampleId): Promise<void>

Defined in: backends/web-backend/src/workbooks/workbook-element-registry.ts:16

Parameters ​

workbookId ​

string

acting ​
username ​

string

exampleId ​

string

Returns ​

Promise<void>

save() ​

save(workbookId, mef): Promise<unknown>

Defined in: backends/web-backend/src/workbooks/workbook-element-registry.ts:13

Parameters ​

workbookId ​

string

mef ​

unknown

Returns ​

Promise<unknown>

validateForReview()? ​

optional validateForReview(mef): string[]

Defined in: backends/web-backend/src/workbooks/workbook-element-registry.ts:14

Parameters ​

mef ​

object

Returns ​

string[]