openvibe-sdk/html

Generated at from openvibe-contracts v0.443.0 and openvibe-sdk v0.177.0.

From types/html.d.ts (server only). Declarations are shown verbatim.

class Raw

Markup that is already safe: html`` returns it, raw() makes it, render() passes it through unescaped.

export declare class Raw {
    constructor(s: unknown);
    readonly s: string;
    toString(): string;
}

type Renderable

A value an html`` hole takes: text is escaped, Raw is kept, arrays are joined, null/undefined/false draw nothing.

export type Renderable = string | number | boolean | null | undefined | Raw | Renderable[];

function esc

export declare function esc(s: unknown): string;

function raw

export declare function raw(s: unknown): Raw;

function html

export declare function html(strings: TemplateStringsArray, ...values: Renderable[]): Raw;

function render

export declare function render(v: Renderable): string;

function code

export declare function code(s: Renderable): Raw;

function time

An ISO time as <time datetime>, read as "2026-11-16 10:00:00 UTC"; '—' when there is none.

export declare function time(iso: string | null | undefined): Raw | '—';

interface TableOptions

export interface TableOptions {
    cls?: string;
    /** Said instead of an empty table. Default 'Nothing here yet.' */
    empty?: string;
}

function table

A table in a focusable, named scroll region; each cell names its column (data-label) for phone layouts.

export declare function table(headers: Renderable[], rows: Renderable[][], options?: TableOptions): Raw;

interface Problem

export interface Problem {
    status?: number;
    code?: string;
    detail?: string;
    requestId?: string;
}

function problemBox

A problem as Network, Events or Media returned it, shown as it came.

export declare function problemBox(p: Problem | null | undefined, options?: { title?: string }): Raw | '';

function notice

export declare function notice(text: Renderable, kind?: string): Raw;

function csrfField

export declare function csrfField(token: string): Raw;

function badge

export declare function badge(text: Renderable, kind?: string): Raw;

interface MarkdownOptions

export interface MarkdownOptions {
    /** How far headings move down, so a page keeps its own h1. Default 1 (# is h2). */
    headingOffset?: number;
    /** The service's own text (ADRs, docs): http(s) links are plain. Default false: rel="nofollow ugc noopener", a new tab. */
    trusted?: boolean;
}

function markdown

Markdown to HTML, escaped first: headings, paragraphs, lists, fenced code, pipe tables, bold, italics, code, links.

export declare function markdown(src: string | null | undefined, options?: MarkdownOptions): string;

function inline

One line's marks (code, bold, italics, links), after escaping.

export declare function inline(s: string, options?: { trusted?: boolean }): string;

const MAX_COLUMNS

A Markdown table's limits: a hostile table costs at most MAX_COLUMNS × MAX_ROWS cells.

export declare const MAX_COLUMNS: 64;

const MAX_ROWS

export declare const MAX_ROWS: 1000;