Type definitions

6min
This article describes the type definitions used by LiSA Library for the Handlebars.js templates' input objects.
According to your custom sections config (see Configuration options﻿), if provided, or the default sections config, LiSA Library creates an array of Section objects and passes it to the Handlebars.js template:
Template input object
interface LibraryInputObject {
  sections: Section[];
}
interface LibraryInputObject {
  sections: Section[];
}
﻿
Input object type definitions
Below you'll find the type definitions for all objects used by LiSA Library.
Asset
Asset
interface Asset {
  orientation: 'landscape' | 'portrait';
  type: 'image' | 'video';
  url: string;
}
interface Asset {
  orientation: 'landscape' | 'portrait';
  type: 'image' | 'video';
  url: string;
}
﻿
Section
Section
interface Section {
  items: Show[];
  title?: string;
  variations: string[];
}
interface Section {
  items: Show[];
  title?: string;
  variations: string[];
}
﻿
Show
Show
interface Show {
  asset?: Asset;
  date?: string;
  hosts?: UserShortProfile[];
  id: string;
  description?: string;
  preview?: Asset;
  state: ShowState;
  tag?: string;
  title?: string;
  variations?: string[];
}
interface Show {
  asset?: Asset;
  date?: string;
  hosts?: UserShortProfile[];
  id: string;
  description?: string;
  preview?: Asset;
  state: ShowState;
  tag?: string;
  title?: string;
  variations?: string[];
}
﻿
ShowState
ShowState
enum ShowState {
  LIVE = "live",
  POST_SHOW = "postShow",
  PRE_SHOW = "preShow",
  REPLAY = "replay"
}
enum ShowState {
  LIVE = "live",
  POST_SHOW = "postShow",
  PRE_SHOW = "preShow",
  REPLAY = "replay"
}
﻿
UserShortProfile
UserShortProfile
interface UserShortProfile {
  active?: boolean;
  avatar?: string;
  id: string;
  displayName: string;
  username: string;
}
interface UserShortProfile {
  active?: boolean;
  avatar?: string;
  id: string;
  displayName: string;
  username: string;
}
﻿
﻿
Updated 25 Mar 2024
Did this page help you?
Bring your own template
Examples