iya-sts
    Preparing search index...

    The shell of the federation pages that are this service's own, and the views they carry.

    Index
    BUNDLE_FILE: "federation-pages-spa.js" = BUNDLE_FILE

    Its file on disk, beside this module.

    SCRIPT_PATH: "/federation/pages.js" = SCRIPT_PATH

    The surface's script's path.

    • The surface's bundle and its precompressed forms, read once. A tree that was never built has none, and the shell then loads a script that says so.

      Returns any

      ShellDocument.readFile()'s { raw, br, gzip, built }

    • Marks a response as one of this surface's pages: its refusals and its outcome are drawn as the shell rather than server-drawn.

      Parameters

      • res: any

        the response

      Returns void

    • The view of a page that is not there: federation turned off, or no relationship by that name.

      Parameters

      • reason: "off" | "noRelationship"

        off or noRelationship

      • Optionalid: string

        the relationship asked for, for noRelationship

      Returns any

      the view

    • Whether a response is one of this surface's pages.

      Parameters

      • res: any

        the response

      Returns boolean

      true where its endpoint marked it

    • A refusal's view: what was refused and why, English (#539's decision 6), and the relationship it is recorded on.

      Parameters

      • what: string

        what was refused, as text

      • why: string

        why, as text

      • relationship: string

        the relationship's id, or ''

      Returns any

      the view

    • Answers GET /federation/pages.js: the bundle, brotli, gzip or neither by the request's Accept-Encoding.

      Parameters

      • req: any

        the request

      • res: any

        the response

      Returns void

    • Sends the surface's shell carrying a page's view, with the status the page always had.

      Parameters

      • res: any

        the response

      • status: number

        the status

      • view: any

        the page's view

      • Optionalopts: { application?: string; own?: any; person?: string }

        application, for the locale policy's default, own, a signed-in person's own language, and person, that person, whose groups may name the locale profile (#1238)

      Returns void