FrankerFaceZClass: Metadata
modules/metadata.Metadata
Hierarchy
↳
Metadata
Accessors
keys
• get keys(): string[]
Return an array of all metadata definition keys.
Returns
string[]
Defined in
Methods
define
▸ define<TData>(key, definition?): void
Add or update a metadata definition. This method updates the entry in definitions, and then it updates every live metadata display to reflect the updated definition.
Type parameters
| Name |
|---|
TData |
Parameters
| Name | Type | Description |
|---|---|---|
key | string | A unique key for the metadata. |
definition? | null | MetadataDefinition<TData> | Your metadata's definition, or null to remove it. |
Returns
void
Example
Adding a simple metadata definition that displays when the channel went live.
typescript
metadata.define('when-live', {
setup(data) {
return data.channel?.live && data.channel.live_since;
},
label(live_since) {
return live_since;
}
});metadata.define('when-live', {
setup(data) {
return data.channel?.live && data.channel.live_since;
},
label(live_since) {
return live_since;
}
});Defined in
renderLegacy
▸ renderLegacy(key, data, container, timers, refresh_fn): Promise<void>
Render a metadata definition into a container. This is used internally to render metadata.
Parameters
| Name | Type | Description |
|---|---|---|
key | string | The metadata's unique key. |
data | MetadataState | The initial state |
container | HTMLElement | The container to render into |
timers | Record<string, Timeout> | An object to store timers for re-rendering |
refresh_fn | (key: string) => void | A method to call when the metadata should be re-rendered. |
Returns
Promise<void>
Defined in
updateMetadata
▸ updateMetadata(keys?): void
Update the rendered metadata elements for a key or keys. If keys is not provided, this will update every metadata element.
Parameters
| Name | Type | Description |
|---|---|---|
keys? | string | string[] | Optional. The key or keys that should be updated. |
Returns
void