Class Library

constructor

• new Library(o: Library | LibraryCfg): Library

  Library constructor

  Parameters

  • o: Library | LibraryCfg

  Returns Library

icon

Optionalid

layout

name

toJson

• get toJson(): any

  Returns any

delete

• delete(): Promise<void>

  Returns Promise<void>

suitableFor

• suitableFor(what: string): any

  Parameters

  • what: string

  Returns any

update

• update(row: Row): Promise<void>

  Parameters

  • row: Row

  Returns Promise<void>

Staticcreate

• create(lib_in: LibraryCfg): Promise<number>

  Parameters

  • lib_in: LibraryCfg

  Returns Promise<number>

  id of the created library item

Staticfind

• find(where: Where, selectopts?: SelectOptions): Promise<Library[]>

  Parameters

  • where: Where
  • Optionalselectopts: SelectOptions

  Returns Promise<Library[]>

StaticfindOne

• findOne(where: Where): Promise<Library>

  Parameters

  • where: Where

  Returns Promise<Library>

StaticresolveSegment

• resolveSegment(segment: any, req: any, visitedIds?: Set<number>): Promise<void>

  Swaps a {type: "library"} reference for its real content, so it renders as if it had been part of the page all along.

  Parameters

  • segment: any
  • req: any
  • visitedIds: Set<number> = ...

    library ids seen so far on this branch, so a library that contains itself renders blank instead of looping forever

  Returns Promise<void>

StaticsaveLibraryUpdates

• saveLibraryUpdates(
      libraryUpdates: { layout: any; library_id: number }[],
  ): Promise<void>

  Saves edits made inside a shared component back to its library row. Last write wins - no live push or conflict detection.

  Parameters

  • libraryUpdates: { layout: any; library_id: number }[]

  Returns Promise<void>