Interface Rule

Rule defining how text should be synthesized by a text-to-speech client, and where the generated audio asset/s should be hosted.

interface Rule {
    audioInnerHTML?: ((...args) => string);
    cssSelectors: string[];
    hosting: {
        config: {} & {
            [k: string]: unknown;
        };
        write: ((...args) => Promise<{
            error?: undefined;
            value: {
                href: string;
                message: string;
            };
        } | {
            error: Error;
            value?: undefined;
        }>);
    };
    regex: RegExp;
    synthesis: {
        config: {} & {
            [k: string]: unknown;
        };
        extension: string;
        synthesize: ((...args) => Promise<{
            error?: undefined;
            value: Readable;
        } | {
            error: Error;
            value?: undefined;
        }>);
    };
    xPathExpressions: string[];
}

Properties

audioInnerHTML? cssSelectors hosting regex synthesis xPathExpressions

Properties

Optional audioInnerHTML

audioInnerHTML?: ((...args) => string) = ...

Type declaration

    • (...args): string

    • Parameters

      • Rest ...args: [string[], ...unknown[]]

      Returns string

cssSelectors

cssSelectors: string[] = ...

hosting

hosting: {
    config: {} & {
        [k: string]: unknown;
    };
    write: ((...args) => Promise<{
        error?: undefined;
        value: {
            href: string;
            message: string;
        };
    } | {
        error: Error;
        value?: undefined;
    }>);
} = ...

Type declaration

  • config: {} & {
        [k: string]: unknown;
    }
  • write: ((...args) => Promise<{
        error?: undefined;
        value: {
            href: string;
            message: string;
        };
    } | {
        error: Error;
        value?: undefined;
    }>)
      • (...args): Promise<{
            error?: undefined;
            value: {
                href: string;
                message: string;
            };
        } | {
            error: Error;
            value?: undefined;
        }>

      • Parameters

        • Rest ...args: unknown[]

        Returns Promise<{
            error?: undefined;
            value: {
                href: string;
                message: string;
            };
        } | {
            error: Error;
            value?: undefined;
        }>

regex

regex: RegExp = ...

synthesis

synthesis: {
    config: {} & {
        [k: string]: unknown;
    };
    extension: string;
    synthesize: ((...args) => Promise<{
        error?: undefined;
        value: Readable;
    } | {
        error: Error;
        value?: undefined;
    }>);
} = ...

Type declaration

  • config: {} & {
        [k: string]: unknown;
    }
  • extension: string
  • synthesize: ((...args) => Promise<{
        error?: undefined;
        value: Readable;
    } | {
        error: Error;
        value?: undefined;
    }>)
      • (...args): Promise<{
            error?: undefined;
            value: Readable;
        } | {
            error: Error;
            value?: undefined;
        }>

      • Parameters

        • Rest ...args: [string, ...unknown[]]

        Returns Promise<{
            error?: undefined;
            value: Readable;
        } | {
            error: Error;
            value?: undefined;
        }>

xPathExpressions

xPathExpressions: string[] = ...

Settings

Member Visibility

Theme

On This Page

audioInnerHTMLcssSelectorshostingregexsynthesisxPathExpressions