@metreeca/qest - v0.12.0
    Preparing search index...

    Function decodeTemplate

    • Decodes a template from an encoded string.

      Parses an encoded string into a Template, recursively resolving internal IRIs against the provided base. The input encoding is auto-detected, accepting any of the output formats produced by encodeTemplate. The decoded template is validated and deeply frozen unless lenient is true.

      The empty retrieval model {} is accepted alongside proper templates: it is an Atomic requesting nothing beyond the server defaults, and callers are expected to serve it as a request carrying no query component.

      Parameters

      • encoded: string

        The encoded Template or empty retrieval model, in any of the formats produced by encodeTemplate

      • options: DecoderOpts = {}

        Decoding options

        Configuration options for decoding operations.

        • Optional Readonlybase?: IRI

          Base IRI for IRI resolution (must be absolute and hierarchical).

          Resolves internal IRIs to absolute form.

          If omitted, IRIs are resolved against the app namespace IRI (app:/#).

        • Optional Readonlylenient?: boolean

          Disables structural validation after decoding.

          Allows the caller to handle validation independently using more advanced or specialised tools, for example for improved error reporting.

          • When true, structural checks are skipped and only syntax errors are reported through exceptions
          • When false, both syntax and structural errors are reported through exceptions

          If omitted, decoders apply internal structural validators to the input.

      Returns Template

      The decoded deeply immutable template with resolved IRIs, or the empty retrieval model

      TypeError If base is not a hierarchical IRI

      TypeError If the decoded value fails structural validation (unless lenient is true)

      SyntaxError If encoded cannot be parsed as JSON, URL-encoded JSON, or base64url-encoded JSON

      decodeTemplate(
        '{"items":{"name":{},"?vendor":"/vendors/acme"}}',
        { base: "https://example.com/" }
      );
      // → { items: { name: {}, "?vendor": "https://example.com/vendors/acme" } }

    Settings

    Member Visibility