Documentation
    Preparing search index...

    Interface TwingSynchronousArrayLoader

    interface TwingSynchronousArrayLoader {
        exists: (name: string, from: null | string) => boolean;
        getSource: (name: string, from: null | string) => null | TwingSource;
        isFresh: (
            name: string,
            time: number,
            from: null | string,
        ) => null | boolean;
        resolve: (name: string, from: null | string) => null | string;
        setTemplate(name: string, template: string): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    exists getSource isFresh resolve

    Methods

    setTemplate

    Properties

    exists: (name: string, from: null | string) => boolean

    Check if we have the source code of a template, given its name.

    Type declaration

      • (name: string, from: null | string): boolean

      • Parameters

        • name: string

          The name of the template to check if we can load

        • from: null | string

          The source that initiated the template loading

        Returns boolean

        If the template source code is handled by this loader or not

    getSource: (name: string, from: null | string) => null | TwingSource

    Returns the source for a given template logical name.

    Type declaration

      • (name: string, from: null | string): null | TwingSource

      • Parameters

        • name: string

          The template logical name

        • from: null | string

          The source that initiated the template loading

        Returns null | TwingSource

    isFresh: (name: string, time: number, from: null | string) => null | boolean

    Returns true if the template is still fresh.

    Type declaration

      • (name: string, time: number, from: null | string): null | boolean

      • Parameters

        • name: string

          The template name

        • time: number

          Timestamp of the last modification time of the cached template

        • from: null | string

          The source that initiated the template loading

        Returns null | boolean

        true if the template is fresh, false otherwise; null if it does not exist

    TwingErrorLoader When name is not found

    resolve: (name: string, from: null | string) => null | string

    Resolve a template FQN from its name and the name of the template that initiated the loading.

    Type declaration

      • (name: string, from: null | string): null | string

      • Parameters

        • name: string

          The name of the template to load

        • from: null | string

          The source that initiated the template loading

        Returns null | string

        The cache key

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods