diff --git a/classes/wonder_stuff_core_src.KindError.html b/classes/wonder_stuff_core_src.KindError.html index 69d495fe..23ac609d 100644 --- a/classes/wonder_stuff_core_src.KindError.html +++ b/classes/wonder_stuff_core_src.KindError.html @@ -3,7 +3,7 @@ well as causal relationships between itself and another source error. More specific variations can be built off this to provide a payload for logging setups like Sentry or winston.

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

cause kind message @@ -22,7 +22,7 @@ Defaults to Errors.Unknown.

  • Optional options: Options = ...

    Options for constructing the error.

    • Returns KindError

    Memberof

    KindError

    -

    Properties

    Readonly cause

    cause: undefined | null | Error

    Readonly kind

    kind: string

    message

    message: string

    Readonly metadata

    metadata: undefined | null | Readonly<Metadata>

    name

    name: string

    Readonly originalMessage

    originalMessage: string

    Readonly originalStack

    originalStack: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Properties

    Readonly cause

    cause: undefined | null | Error

    Readonly kind

    kind: string

    message

    message: string

    Readonly metadata

    metadata: undefined | null | Readonly<Metadata>

    name

    name: string

    Readonly originalMessage

    originalMessage: string

    Readonly originalStack

    originalStack: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/wonder_stuff_core_src.UnreachableCaseError.html b/classes/wonder_stuff_core_src.UnreachableCaseError.html index 47d60934..bd98f7c0 100644 --- a/classes/wonder_stuff_core_src.UnreachableCaseError.html +++ b/classes/wonder_stuff_core_src.UnreachableCaseError.html @@ -9,7 +9,7 @@ TypeScript will report an error. This is becasue the first parameter of UnreachableCaseError's constructor is typed as never and nothing can be assigned (or passed) to something typed as never.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    cause kind message @@ -21,7 +21,7 @@ prepareStackTrace? stackTraceLimit

    Methods

    captureStackTrace -

    Constructors

    constructor

    Properties

    Readonly cause

    cause: undefined | null | Error

    Readonly kind

    kind: string

    message

    message: string

    Readonly metadata

    metadata: undefined | null | Readonly<Metadata>

    name

    name: string

    Readonly originalMessage

    originalMessage: string

    Readonly originalStack

    originalStack: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

      • (err, stackTraces): any

      • Optional override for formatting stack traces

        +

    Constructors

    constructor

    Properties

    Readonly cause

    cause: undefined | null | Error

    Readonly kind

    kind: string

    message

    message: string

    Readonly metadata

    metadata: undefined | null | Readonly<Metadata>

    name

    name: string

    Readonly originalMessage

    originalMessage: string

    Readonly originalStack

    originalStack: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/wonder_stuff_i18n_src.I18nPlugin.html b/classes/wonder_stuff_i18n_src.I18nPlugin.html index e593345f..d84b927a 100644 --- a/classes/wonder_stuff_i18n_src.I18nPlugin.html +++ b/classes/wonder_stuff_i18n_src.I18nPlugin.html @@ -1,4 +1,4 @@ -I18nPlugin | wonder-stuff

    Class I18nPlugin

    Hierarchy

    • I18nPlugin

    Constructors

    constructor +I18nPlugin | wonder-stuff

    Class I18nPlugin

    Hierarchy

    • I18nPlugin

    Constructors

    constructor

    Properties

    options

    Methods

    apply getTranslatedStrings @@ -6,21 +6,21 @@ log onEmit translateAssets -

    Constructors

    constructor

    Properties

    options

    options: InternalOptions

    Methods

    apply

    getTranslatedStrings

    • Get all the translated strings from Crowdin. The results are stored and +

    Constructors

    constructor

    Properties

    options

    options: InternalOptions

    Methods

    apply

    getTranslatedStrings

    • Get all the translated strings from Crowdin. The results are stored and returned in a map of locale to string map.

      Parameters

      • locales: string[]

        the locales to get the strings for

      Returns Promise<TranslatedStrings>

      a mapping of locale to msgId to string data

      -

    localizeManifests

    localizeManifests

    • Update manifest files so that they point to the correct location of the translated files.

      -

      Parameters

      • options: {
            assets: Assets;
            hashMap: HashMaps;
        }
        • assets: Assets
        • hashMap: HashMaps

      Returns void

    log

    log

    onEmit

    • Logic to run when emitting the files. This will get the translated +

    Returns void

    onEmit

    translateAssets

    translateAssets

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/wonder_stuff_render_environment_jsdom_src.Configuration.html b/classes/wonder_stuff_render_environment_jsdom_src.Configuration.html index 9413222d..b9d0472e 100644 --- a/classes/wonder_stuff_render_environment_jsdom_src.Configuration.html +++ b/classes/wonder_stuff_render_environment_jsdom_src.Configuration.html @@ -1,5 +1,5 @@ Configuration | wonder-stuff

    Class Configuration

    Utility for creating a valid configuration to use with the JSDOM environment.

    -

    Hierarchy

    • Configuration

    Implements

    Constructors

    constructor +

    Hierarchy

    • Configuration

    Implements

    Constructors

    constructor

    Properties

    afterEnvSetup getFileList getResourceLoader @@ -21,4 +21,4 @@
      • (url, fileURLs, renderAPI, vmContext?): Promise<undefined | null | ICloseable>

      • Parameters

        • url: string
        • fileURLs: readonly string[]
        • renderAPI: RenderAPI
        • Optional vmContext: any

        Returns Promise<undefined | null | ICloseable>

  • Optional registrationCallbackName: string = "__jsdom_env_register"

    The name of the function that the environment should expose for client code to register for rendering. This defaults to __jsdom_env_register.

    -

    • Returns Configuration

    Properties

    Readonly afterEnvSetup

    afterEnvSetup: ((url, fileURLs, renderAPI, vmContext?) => Promise<undefined | null | ICloseable>)

    Type declaration

      • (url, fileURLs, renderAPI, vmContext?): Promise<undefined | null | ICloseable>

      • Parameters

        • url: string
        • fileURLs: readonly string[]
        • renderAPI: RenderAPI
        • Optional vmContext: any

        Returns Promise<undefined | null | ICloseable>

    Readonly getFileList

    getFileList: ((url, renderAPI, fetchFn) => Promise<string[]>)

    Type declaration

      • (url, renderAPI, fetchFn): Promise<string[]>

      • Parameters

        • url: string
        • renderAPI: RenderAPI
        • fetchFn: ((url) => undefined | null | Promise<Buffer>)
            • (url): undefined | null | Promise<Buffer>

            • Parameters

              • url: string

              Returns undefined | null | Promise<Buffer>

        Returns Promise<string[]>

    Readonly getResourceLoader

    getResourceLoader: ((url, renderAPI) => CloseableResourceLoader)

    Type declaration

      • (url, renderAPI): CloseableResourceLoader

      • Parameters

        Returns CloseableResourceLoader

    Readonly registrationCallbackName

    registrationCallbackName: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Configuration

    Properties

    Readonly afterEnvSetup

    afterEnvSetup: ((url, fileURLs, renderAPI, vmContext?) => Promise<undefined | null | ICloseable>)

    Type declaration

      • (url, fileURLs, renderAPI, vmContext?): Promise<undefined | null | ICloseable>

      • Parameters

        • url: string
        • fileURLs: readonly string[]
        • renderAPI: RenderAPI
        • Optional vmContext: any

        Returns Promise<undefined | null | ICloseable>

    Readonly getFileList

    getFileList: ((url, renderAPI, fetchFn) => Promise<string[]>)

    Type declaration

      • (url, renderAPI, fetchFn): Promise<string[]>

      • Parameters

        • url: string
        • renderAPI: RenderAPI
        • fetchFn: ((url) => undefined | null | Promise<Buffer>)
            • (url): undefined | null | Promise<Buffer>

            • Parameters

              • url: string

              Returns undefined | null | Promise<Buffer>

        Returns Promise<string[]>

    Readonly getResourceLoader

    getResourceLoader: ((url, renderAPI) => CloseableResourceLoader)

    Type declaration

      • (url, renderAPI): CloseableResourceLoader

      • Parameters

        Returns CloseableResourceLoader

    Readonly registrationCallbackName

    registrationCallbackName: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/wonder_stuff_render_environment_jsdom_src.Environment.html b/classes/wonder_stuff_render_environment_jsdom_src.Environment.html index c376a1bf..f40790e1 100644 --- a/classes/wonder_stuff_render_environment_jsdom_src.Environment.html +++ b/classes/wonder_stuff_render_environment_jsdom_src.Environment.html @@ -1,5 +1,5 @@ Environment | wonder-stuff

    Class Environment

    A render environment built to support the JSDOM 16.x API.

    -

    Hierarchy

    • Environment

    Implements

    Constructors

    constructor +

    Hierarchy

    • Environment

    Implements

    Constructors

    constructor

    Properties

    _configuration _retrieveTargetFiles render @@ -7,7 +7,7 @@ _runScript

    Constructors

    constructor

    Properties

    _configuration

    _configuration: IJSDOMConfiguration

    _retrieveTargetFiles

    _retrieveTargetFiles: ((url, renderAPI, resourceLoader) => Promise<JavaScriptFiles>) = ...

    Type declaration

      • (url, renderAPI, resourceLoader): Promise<JavaScriptFiles>

      • Parameters

        • url: string
        • renderAPI: RenderAPI
        • resourceLoader: CloseableResourceLoader

        Returns Promise<JavaScriptFiles>

    render

    render: ((url, renderAPI) => Promise<RenderResult>) = ...

    Type declaration

      • (url, renderAPI): Promise<RenderResult>

      • Generate a render result for the given url.

        +

    Returns Environment

    Properties

    _configuration

    _configuration: IJSDOMConfiguration

    _retrieveTargetFiles

    _retrieveTargetFiles: ((url, renderAPI, resourceLoader) => Promise<JavaScriptFiles>) = ...

    Type declaration

      • (url, renderAPI, resourceLoader): Promise<JavaScriptFiles>

      • Parameters

        • url: string
        • renderAPI: RenderAPI
        • resourceLoader: CloseableResourceLoader

        Returns Promise<JavaScriptFiles>

    render

    render: ((url, renderAPI) => Promise<RenderResult>) = ...

    Type declaration

      • (url, renderAPI): Promise<RenderResult>

      • Generate a render result for the given url.

        Parameters

        • url: string

          The URL that is to be rendered. This is always relative to the host and so does not contain protocol, hostname, nor port information.

          @@ -16,4 +16,4 @@

        Returns Promise<RenderResult>

        The result of the render that is to be returned by the gateway service as the response to the render request. This includes the body of the response and the status code information.

        -

    Methods

    _closeAll

    _runScript

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Methods

    _closeAll

    _runScript

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/wonder_stuff_render_environment_jsdom_src.FileResourceLoader.html b/classes/wonder_stuff_render_environment_jsdom_src.FileResourceLoader.html index cb60d47c..11994d15 100644 --- a/classes/wonder_stuff_render_environment_jsdom_src.FileResourceLoader.html +++ b/classes/wonder_stuff_render_environment_jsdom_src.FileResourceLoader.html @@ -1,8 +1,8 @@ FileResourceLoader | wonder-stuff

    Class FileResourceLoader

    A ResourceLoader implementation for JSDOM that loads files from disk.

    -

    Hierarchy

    • ResourceLoader
      • FileResourceLoader

    Constructors

    constructor +

    Hierarchy

    • ResourceLoader
      • FileResourceLoader

    Constructors

    constructor

    Properties

    _makeFilePath _rootFolder

    Methods

    fetch

    Constructors

    constructor

    Properties

    _makeFilePath

    _makeFilePath: ((arg1) => string) = ...

    Type declaration

      • (arg1): string

      • Parameters

        • arg1: string

        Returns string

    _rootFolder

    _rootFolder: string

    Methods

    fetch

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns FileResourceLoader

    Properties

    _makeFilePath

    _makeFilePath: ((arg1) => string) = ...

    Type declaration

      • (arg1): string

      • Parameters

        • arg1: string

        Returns string

    _rootFolder

    _rootFolder: string

    Methods

    fetch

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/wonder_stuff_render_environment_jsdom_src.ResourceLoader.html b/classes/wonder_stuff_render_environment_jsdom_src.ResourceLoader.html index 27c188c5..5d1b2c29 100644 --- a/classes/wonder_stuff_render_environment_jsdom_src.ResourceLoader.html +++ b/classes/wonder_stuff_render_environment_jsdom_src.ResourceLoader.html @@ -6,7 +6,7 @@

    The caller is responsible for maintaining script order based on call order.

    A JS file request is identified by the regular expression: /^..js(?:?.)?/g

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    • ResourceLoader
      • ResourceLoader

    Constructors

    constructor

    Properties

    _active _agents _handleFetchResult @@ -20,6 +20,6 @@

    Constructors

    constructor

    • Create instance of the resource loader.

      Parameters

      • renderAPI: RenderAPI
      • Optional requestOptions: RequestOptions = Requests.DefaultRequestOptions

        Options that calibrate how requests are performed for this loader.

        -
      • Optional handleFetchResult: ((result, url, options) => void | Promise<Buffer>)
          • (result, url, options): void | Promise<Buffer>

          • Parameters

            • result: void | Promise<Buffer>
            • url: string
            • options: FetchOptions

            Returns void | Promise<Buffer>

      Returns ResourceLoader

    Properties

    _active

    _active: boolean

    Used to indicate if any pending requests are still needed so that we +

  • Optional handleFetchResult: ((result, url, options) => void | Promise<Buffer>)
      • (result, url, options): void | Promise<Buffer>

      • Parameters

        • result: void | Promise<Buffer>
        • url: string
        • options: FetchOptions

        Returns void | Promise<Buffer>

    • Returns ResourceLoader

    Properties

    _active

    _active: boolean

    Used to indicate if any pending requests are still needed so that we can report when an unused request is fulfilled.

    -

    _agents

    _agents: {
        [protocol: string]: HttpAgent | HttpsAgent;
    }

    Type declaration

    • [protocol: string]: HttpAgent | HttpsAgent

    _handleFetchResult

    _handleFetchResult: void | ((result, url, options) => void | Promise<Buffer>)

    Type declaration

      • (result, url, options): void | Promise<Buffer>

      • Parameters

        • result: void | Promise<Buffer>
        • url: string
        • options: FetchOptions

        Returns void | Promise<Buffer>

    _renderAPI

    _renderAPI: RenderAPI

    _requestOptions

    _requestOptions: RequestOptions

    Accessors

    isActive

    Static EMPTY_RESPONSE

    Methods

    _getAgent

    close

    fetch

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    _agents

    _agents: {
        [protocol: string]: HttpAgent | HttpsAgent;
    }

    Type declaration

    _handleFetchResult

    _handleFetchResult: void | ((result, url, options) => void | Promise<Buffer>)

    Type declaration

    _renderAPI

    _renderAPI: RenderAPI

    _requestOptions

    _requestOptions: RequestOptions

    Accessors

    isActive

    Static EMPTY_RESPONSE

    Methods

    _getAgent

    close

    fetch

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/wonder_stuff_sentry_src.KindErrorData.html b/classes/wonder_stuff_sentry_src.KindErrorData.html index 045855d3..39c06ba4 100644 --- a/classes/wonder_stuff_sentry_src.KindErrorData.html +++ b/classes/wonder_stuff_sentry_src.KindErrorData.html @@ -1,8 +1,8 @@ -KindErrorData | wonder-stuff

    Class KindErrorData

    Hierarchy

    • KindErrorData

    Implements

    • SentryIntegration

    Constructors

    constructor +KindErrorData | wonder-stuff

    Class KindErrorData

    Hierarchy

    • KindErrorData

    Implements

    • SentryIntegration

    Constructors

    constructor

    Properties

    _options name id

    Methods

    enhanceEventWithErrorData setupOnce -

    Constructors

    constructor

    Properties

    Readonly _options

    _options: KindErrorDataOptions

    name

    name: string = KindErrorData.id

    Static id

    id: string = "KindErrorData"

    Methods

    enhanceEventWithErrorData

    • Attaches extracted information from the Error object to extra field in the Event

      -

      Parameters

      • event: SentryEvent
      • Optional hint: SentryEventHint

      Returns SentryEvent

    setupOnce

    • Parameters

      • addGlobalEventProcessor: ((callback) => void)
          • (callback): void

          • Parameters

            • callback: SentryEventProcessor

            Returns void

      • getCurrentHub: (() => SentryHub)
          • (): SentryHub

          • Returns SentryHub

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Readonly _options

    _options: KindErrorDataOptions

    name

    name: string = KindErrorData.id

    Static id

    id: string = "KindErrorData"

    Methods

    enhanceEventWithErrorData

    • Attaches extracted information from the Error object to extra field in the Event

      +

      Parameters

      • event: SentryEvent
      • Optional hint: SentryEventHint

      Returns SentryEvent

    setupOnce

    • Parameters

      • addGlobalEventProcessor: ((callback) => void)
          • (callback): void

          • Parameters

            • callback: SentryEventProcessor

            Returns void

      • getCurrentHub: (() => SentryHub)
          • (): SentryHub

          • Returns SentryHub

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/wonder_stuff_sentry_src.KindSentryError.html b/classes/wonder_stuff_sentry_src.KindSentryError.html index a3244589..ab3b8e47 100644 --- a/classes/wonder_stuff_sentry_src.KindSentryError.html +++ b/classes/wonder_stuff_sentry_src.KindSentryError.html @@ -1,6 +1,6 @@ KindSentryError | wonder-stuff

    Class KindSentryError

    An error that can be used to capture details for reporting to Sentry.

    The error kind will be a tag on the reported Sentry event.

    -

    Export

    Hierarchy

    Constructors

    constructor +

    Export

    Hierarchy

    Constructors

    constructor

    Properties

    cause kind message @@ -20,7 +20,7 @@ Defaults to Errors.Unknown.

  • Optional options: Options = ...

    Options for constructing the error.

    • Returns KindSentryError

    Memberof

    KindSentryError

    -

    Properties

    Readonly cause

    cause: undefined | null | Error

    Readonly kind

    kind: string

    message

    message: string

    Readonly metadata

    metadata: undefined | null | Readonly<Metadata>

    name

    name: string

    Readonly originalMessage

    originalMessage: string

    Readonly originalStack

    originalStack: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Properties

    Readonly cause

    cause: undefined | null | Error

    Readonly kind

    kind: string

    message

    message: string

    Readonly metadata

    metadata: undefined | null | Readonly<Metadata>

    name

    name: string

    Readonly originalMessage

    originalMessage: string

    Readonly originalStack

    originalStack: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    sentryData

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      +

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    sentryData

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/wonder_stuff_server_src.Runtime.html b/enums/wonder_stuff_server_src.Runtime.html index e2e7663c..df620c53 100644 --- a/enums/wonder_stuff_server_src.Runtime.html +++ b/enums/wonder_stuff_server_src.Runtime.html @@ -1,5 +1,5 @@ Runtime | wonder-stuff

    Enumeration Runtime

    The runtime modes that a gateway can run under.

    -

    Enumeration Members

    Development +

    Enumeration Members

    Development Production Test -

    Enumeration Members

    Development

    Development: "development"

    Production

    Production: "production"

    Test

    Test: "test"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    Development

    Development: "development"

    Production

    Production: "production"

    Test

    Test: "test"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/wonder_stuff_core_src.clone.html b/functions/wonder_stuff_core_src.clone.html index c971cca8..e702a916 100644 --- a/functions/wonder_stuff_core_src.clone.html +++ b/functions/wonder_stuff_core_src.clone.html @@ -2,4 +2,4 @@

    This produces a deep clone of a given value.

    Type Parameters

    Parameters

    Returns T

    The cloned value.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/wonder_stuff_core_src.entries.html b/functions/wonder_stuff_core_src.entries.html index 5bfa2bf7..13765359 100644 --- a/functions/wonder_stuff_core_src.entries.html +++ b/functions/wonder_stuff_core_src.entries.html @@ -2,8 +2,8 @@

    Type Parameters

    Parameters

    Returns [string, T][]

    An array of key/value tuples for the object.

    -

  • Return an array of key/value tuples for an object.

    +

  • Return an array of key/value tuples for an object.

    Parameters

    Returns [string, any][]

    An array of key/value tuples for the object.

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/wonder_stuff_core_src.errorsFromError.html b/functions/wonder_stuff_core_src.errorsFromError.html index 85229a3c..87a5ce7c 100644 --- a/functions/wonder_stuff_core_src.errorsFromError.html +++ b/functions/wonder_stuff_core_src.errorsFromError.html @@ -4,4 +4,4 @@ chaining through causal KindErrors accordingly.

    If reverse is true, the generated sequence starts with the lowermost causal error and ends with the given error.

    -

    Parameters

    Returns Iterator<Error>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Iterator<Error>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/wonder_stuff_core_src.getKindFromError.html b/functions/wonder_stuff_core_src.getKindFromError.html index 79e4409d..6331437c 100644 --- a/functions/wonder_stuff_core_src.getKindFromError.html +++ b/functions/wonder_stuff_core_src.getKindFromError.html @@ -1,2 +1,2 @@ getKindFromError | wonder-stuff

    Function getKindFromError

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/wonder_stuff_core_src.getOriginalStackFromError.html b/functions/wonder_stuff_core_src.getOriginalStackFromError.html index dc91a8e3..faacae21 100644 --- a/functions/wonder_stuff_core_src.getOriginalStackFromError.html +++ b/functions/wonder_stuff_core_src.getOriginalStackFromError.html @@ -1,2 +1,2 @@ getOriginalStackFromError | wonder-stuff

    Function getOriginalStackFromError

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/wonder_stuff_core_src.isNonNullable.html b/functions/wonder_stuff_core_src.isNonNullable.html index a759f6ff..75c54cea 100644 --- a/functions/wonder_stuff_core_src.isNonNullable.html +++ b/functions/wonder_stuff_core_src.isNonNullable.html @@ -7,4 +7,4 @@ following type: Array<string | number | boolean>.

    NOTE: The term "nullable" in TypeScript refers to either null or undefined. This terminology is taken from https://www.typescriptlang.org/docs/handbook/utility-types.html#nonnullabletype.

    -

    Type Parameters

    Parameters

    Returns x is T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns x is T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/wonder_stuff_core_src.isTruthy.html b/functions/wonder_stuff_core_src.isTruthy.html index 8ef9b4e5..4df75f17 100644 --- a/functions/wonder_stuff_core_src.isTruthy.html +++ b/functions/wonder_stuff_core_src.isTruthy.html @@ -5,4 +5,4 @@ const truthyArray = array.filter(isTruthy);

    truthyArray will be [5, true, "hello"] and will have the following type: Array<string | number | true>.

    -

    Type Parameters

    Parameters

    Returns x is T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns x is T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/wonder_stuff_core_src.keys.html b/functions/wonder_stuff_core_src.keys.html index 849ae178..2b55058e 100644 --- a/functions/wonder_stuff_core_src.keys.html +++ b/functions/wonder_stuff_core_src.keys.html @@ -2,4 +2,4 @@

    Type Parameters

    Parameters

    Returns (keyof O)[]

    An array of the enumerable keys of an object.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/wonder_stuff_core_src.safeStringify.html b/functions/wonder_stuff_core_src.safeStringify.html index a8c09743..6e63c2d9 100644 --- a/functions/wonder_stuff_core_src.safeStringify.html +++ b/functions/wonder_stuff_core_src.safeStringify.html @@ -2,9 +2,9 @@

    Type Parameters

    Parameters

    Returns string

    The stringified value or the default value.

    -

  • Stringify an item, returning an empty string on error, null, or undefined.

    +

  • Stringify an item, returning an empty string on error, null, or undefined.

    Type Parameters

    Parameters

    Returns string

    The stringified value.

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/wonder_stuff_core_src.secret.html b/functions/wonder_stuff_core_src.secret.html index 0c0f5dbd..4c5ad325 100644 --- a/functions/wonder_stuff_core_src.secret.html +++ b/functions/wonder_stuff_core_src.secret.html @@ -1,2 +1,2 @@ secret | wonder-stuff

    Function secret

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns SecretString

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/wonder_stuff_core_src.truncateMiddle.html b/functions/wonder_stuff_core_src.truncateMiddle.html index de926f45..83775174 100644 --- a/functions/wonder_stuff_core_src.truncateMiddle.html +++ b/functions/wonder_stuff_core_src.truncateMiddle.html @@ -5,4 +5,4 @@

    Returns string

    The string, if it is less than or equal to maxLength; otherwise, the string truncated to maxLength - 3 characters with an ellipsis in the middle.

    -

    Export

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Export

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/wonder_stuff_core_src.values.html b/functions/wonder_stuff_core_src.values.html index 86996311..db6fdafa 100644 --- a/functions/wonder_stuff_core_src.values.html +++ b/functions/wonder_stuff_core_src.values.html @@ -2,8 +2,8 @@

    Type Parameters

    Parameters

    Returns T[]

    An array of the enumerable property values of the object.

    -

  • Return an array of the enumerable property values of an object.

    +

  • Return an array of the enumerable property values of an object.

    Parameters

    Returns any[]

    An array of the enumerable property values of the object.

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/wonder_stuff_i18n_src.extractStrings.html b/functions/wonder_stuff_i18n_src.extractStrings.html index 205ebbb2..274379cb 100644 --- a/functions/wonder_stuff_i18n_src.extractStrings.html +++ b/functions/wonder_stuff_i18n_src.extractStrings.html @@ -12,4 +12,4 @@ msgids: Array, // The comments associated with the string. comments: Array,

    -

    Parameters

    • textString: string

    Returns Generator<ExtractedString, void, void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • textString: string

    Returns Generator<ExtractedString, void, void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/wonder_stuff_i18n_src.getEmojiForLocale.html b/functions/wonder_stuff_i18n_src.getEmojiForLocale.html index b6a198aa..e2918dd5 100644 --- a/functions/wonder_stuff_i18n_src.getEmojiForLocale.html +++ b/functions/wonder_stuff_i18n_src.getEmojiForLocale.html @@ -1,3 +1,3 @@ getEmojiForLocale | wonder-stuff

    Function getEmojiForLocale

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/wonder_stuff_i18n_src.getFilesToExtractFrom.html b/functions/wonder_stuff_i18n_src.getFilesToExtractFrom.html index a499a88b..6d0aa63a 100644 --- a/functions/wonder_stuff_i18n_src.getFilesToExtractFrom.html +++ b/functions/wonder_stuff_i18n_src.getFilesToExtractFrom.html @@ -1,4 +1,4 @@ getFilesToExtractFrom | wonder-stuff

    Function getFilesToExtractFrom

    • Get a list of files to attempt to extract strings from.

      Parameters

      • userSpecifiedFiles: string[]

        a list of files to attempt to extract strings from.

        -

      Returns string[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/wonder_stuff_i18n_src.getI18nStringsFromString.html b/functions/wonder_stuff_i18n_src.getI18nStringsFromString.html index 72d347d6..2e73cb94 100644 --- a/functions/wonder_stuff_i18n_src.getI18nStringsFromString.html +++ b/functions/wonder_stuff_i18n_src.getI18nStringsFromString.html @@ -2,4 +2,4 @@

    Parameters

    • textString: string

      a string of code to extract strings from

    Returns ExtractedString[]

    the strings that were extracted from the given code string

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/wonder_stuff_i18n_src.getIgnoreGlobs.html b/functions/wonder_stuff_i18n_src.getIgnoreGlobs.html index df22408b..679679f6 100644 --- a/functions/wonder_stuff_i18n_src.getIgnoreGlobs.html +++ b/functions/wonder_stuff_i18n_src.getIgnoreGlobs.html @@ -1,3 +1,3 @@ getIgnoreGlobs | wonder-stuff

    Function getIgnoreGlobs

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/wonder_stuff_i18n_src.getPOTFileStringFromFiles.html b/functions/wonder_stuff_i18n_src.getPOTFileStringFromFiles.html index 25979b20..38eb9c20 100644 --- a/functions/wonder_stuff_i18n_src.getPOTFileStringFromFiles.html +++ b/functions/wonder_stuff_i18n_src.getPOTFileStringFromFiles.html @@ -1,4 +1,4 @@ getPOTFileStringFromFiles | wonder-stuff

    Function getPOTFileStringFromFiles

    • Given a list of files, extract i18n strings from them and generate a string version of a POT file.

      Parameters

      • files: string[]

        a list of files to extract strings from files

        -

      Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/wonder_stuff_i18n_src.translateString.html b/functions/wonder_stuff_i18n_src.translateString.html index b7571ad9..67f6701c 100644 --- a/functions/wonder_stuff_i18n_src.translateString.html +++ b/functions/wonder_stuff_i18n_src.translateString.html @@ -7,4 +7,4 @@ file, as done by extract-i18n.js. This is optional, if not provided the strings will be extracted automatically.

    Returns string

    the translated code string

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/wonder_stuff_render_server_src.Requests.request.html b/functions/wonder_stuff_render_server_src.Requests.request.html index 913fa6ea..1e0b3bf4 100644 --- a/functions/wonder_stuff_render_server_src.Requests.request.html +++ b/functions/wonder_stuff_render_server_src.Requests.request.html @@ -2,4 +2,4 @@

    NOTE: The AbortablePromise is only shallowly abortable. If any standard promise methods are called on this, the promise they return no longer will have the abort function. Therefore, you'll need to readd it.

    -

    Parameters

    Returns AbortablePromise<Response>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns AbortablePromise<Response>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/wonder_stuff_render_server_src.extractError.html b/functions/wonder_stuff_render_server_src.extractError.html index d367c9d7..ad663962 100644 --- a/functions/wonder_stuff_render_server_src.extractError.html +++ b/functions/wonder_stuff_render_server_src.extractError.html @@ -3,4 +3,4 @@ a less ambiguous version.

    Parameters

    Returns Readonly<SimplifiedError>

    A simplified error object.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/wonder_stuff_render_server_src.runServer.html b/functions/wonder_stuff_render_server_src.runServer.html index 0c2bca7a..a8596889 100644 --- a/functions/wonder_stuff_render_server_src.runServer.html +++ b/functions/wonder_stuff_render_server_src.runServer.html @@ -2,4 +2,4 @@

    Parameters

    Returns Promise<void>

    The promise of working.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/wonder_stuff_server_src.createLogger.html b/functions/wonder_stuff_server_src.createLogger.html index b9ffbf25..1753826f 100644 --- a/functions/wonder_stuff_server_src.createLogger.html +++ b/functions/wonder_stuff_server_src.createLogger.html @@ -1,2 +1,2 @@ createLogger | wonder-stuff

    Function createLogger

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • __namedParameters: LoggingOptions

    Returns Logger

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/wonder_stuff_server_src.decryptBufferWithKms.html b/functions/wonder_stuff_server_src.decryptBufferWithKms.html index 48424491..ee3971f7 100644 --- a/functions/wonder_stuff_server_src.decryptBufferWithKms.html +++ b/functions/wonder_stuff_server_src.decryptBufferWithKms.html @@ -2,4 +2,4 @@

    Parameters

    • cryptoKeyPath: string

      The path of the KMS crypto key to use.

    • buffer: Buffer

      The buffer to decrypt.

    Returns Promise<Buffer>

    The decrypted buffer.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/wonder_stuff_server_src.getAgentForURL.html b/functions/wonder_stuff_server_src.getAgentForURL.html index 3f81a856..7c467eef 100644 --- a/functions/wonder_stuff_server_src.getAgentForURL.html +++ b/functions/wonder_stuff_server_src.getAgentForURL.html @@ -4,4 +4,4 @@ agent isn't needed (such as at the end of a request), we want to destroy it. Otherwise, it can hang around keeping sockets open which can lead to retaining large chunks of memory and creating memory leaks.

    -

    Parameters

    • url: URL

    Returns Agent | Agent

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • url: URL

    Returns Agent | Agent

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/wonder_stuff_server_src.getAppEngineInfo.html b/functions/wonder_stuff_server_src.getAppEngineInfo.html index 12245b90..f8d6c1cf 100644 --- a/functions/wonder_stuff_server_src.getAppEngineInfo.html +++ b/functions/wonder_stuff_server_src.getAppEngineInfo.html @@ -2,4 +2,4 @@

    Encapsulates the retrieval of gateway information to abstract away things like GAE env vars.

    Returns AppEngineInfo

    The information about the gateway.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/wonder_stuff_server_src.getLogger.html b/functions/wonder_stuff_server_src.getLogger.html index 72fa1f63..2c8d1d77 100644 --- a/functions/wonder_stuff_server_src.getLogger.html +++ b/functions/wonder_stuff_server_src.getLogger.html @@ -7,4 +7,4 @@ as things that are logging should not care. However, in a case where there is no request to use for context, it is equivalent to explicitly requesting the top-level logger.

    -

    Type Parameters

    • TReq extends RequestWithLog<Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>>

    Parameters

    • Optional request: TReq

    Returns Logger

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • TReq extends RequestWithLog<Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>>

    Parameters

    • Optional request: TReq

    Returns Logger

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/wonder_stuff_server_src.getRuntimeMode.html b/functions/wonder_stuff_server_src.getRuntimeMode.html index f3b5b388..01d2f811 100644 --- a/functions/wonder_stuff_server_src.getRuntimeMode.html +++ b/functions/wonder_stuff_server_src.getRuntimeMode.html @@ -2,4 +2,4 @@

    The mode is calculated from NODE_ENV. If NODE_ENV is not set or set to something other than expected values, the defaultMode is returned.

    Returns Runtime

    The runtime mode of production, development, or test.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/wonder_stuff_server_src.setRootLogger.html b/functions/wonder_stuff_server_src.setRootLogger.html index 967be588..9889d904 100644 --- a/functions/wonder_stuff_server_src.setRootLogger.html +++ b/functions/wonder_stuff_server_src.setRootLogger.html @@ -1,2 +1,2 @@ setRootLogger | wonder-stuff

    Function setRootLogger

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • logger: Logger

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/wonder_stuff_server_src.startServer.html b/functions/wonder_stuff_server_src.startServer.html index dcc681fb..b38b25a1 100644 --- a/functions/wonder_stuff_server_src.startServer.html +++ b/functions/wonder_stuff_server_src.startServer.html @@ -2,4 +2,4 @@

    This takes a server application definition and sets up logging middleware and other pieces before listening on the appropriate port per the passed options.

    -

    Parameters

    Returns Promise<http.Server | null | undefined>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<http.Server | null | undefined>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/wonder_stuff_server_src.trace.html b/functions/wonder_stuff_server_src.trace.html index 4e88cb6e..5a7f0e10 100644 --- a/functions/wonder_stuff_server_src.trace.html +++ b/functions/wonder_stuff_server_src.trace.html @@ -1,3 +1,3 @@ trace | wonder-stuff

    Function trace

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • TReq extends RequestWithLog<Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>>

    Parameters

    • action: string
    • message: string
    • Optional request: TReq

    Returns ITraceSession

  • Trace an action with message.

    +

    Parameters

    • action: string
    • message: string
    • logger: Logger

    Returns ITraceSession

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/wonder_stuff_testing_src.dataFactoryFor.html b/functions/wonder_stuff_testing_src.dataFactoryFor.html index b1ac9f93..ad2f8798 100644 --- a/functions/wonder_stuff_testing_src.dataFactoryFor.html +++ b/functions/wonder_stuff_testing_src.dataFactoryFor.html @@ -16,4 +16,4 @@

    Example (deep update):

        const BASE_OBJECT = {
            student: { ... },
            teacher: { ... },
        };
        const dataFactory = dataFactoryFor(BASE_OBJECT);
        const data = dataFactory();
        if (data.user) {
            data.user.kaid = "new_kaid";
            data.user.id = "new_kaid";
        }
    -

    Type Parameters

    • T

    Parameters

    • baseObject: T

    Returns ((partialObject?) => T)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Parameters

    • baseObject: T

    Returns ((partialObject?) => T)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/wonder_stuff_testing_src.jest.afterEachRestoreEnv.html b/functions/wonder_stuff_testing_src.jest.afterEachRestoreEnv.html index ef7aab67..9b66ebd6 100644 --- a/functions/wonder_stuff_testing_src.jest.afterEachRestoreEnv.html +++ b/functions/wonder_stuff_testing_src.jest.afterEachRestoreEnv.html @@ -2,4 +2,4 @@

    This captures the values of the given environment variables on invocation and then, after each test case, it restores those values.

    Parameters

    • Rest ...variableNames: readonly string[]

      The names of the environment variables to restore.

      -

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/wonder_stuff_testing_src.jest.isolateModules.html b/functions/wonder_stuff_testing_src.jest.isolateModules.html index cc4a9fad..da9ed2a2 100644 --- a/functions/wonder_stuff_testing_src.jest.isolateModules.html +++ b/functions/wonder_stuff_testing_src.jest.isolateModules.html @@ -6,4 +6,4 @@ code and not this function. Note that we don't support promises here to discourage dynamic import use, which doesn't play well with standard jest yet.

    -

    Returns T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/wonder_stuff_testing_src.jest.wait.html b/functions/wonder_stuff_testing_src.jest.wait.html index a5ef16d3..30dedb0a 100644 --- a/functions/wonder_stuff_testing_src.jest.wait.html +++ b/functions/wonder_stuff_testing_src.jest.wait.html @@ -1,3 +1,3 @@ wait | wonder-stuff

    Function wait

    • Wait for the given delay as many times as indicated.

      This will throw if jest.useRealTimers() is not used.

      -

      Parameters

      • Optional options: WaitOptions

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • Optional options: WaitOptions

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/wonder_stuff_render_environment_jsdom_src.IJSDOMConfiguration.html b/interfaces/wonder_stuff_render_environment_jsdom_src.IJSDOMConfiguration.html index d757cea6..b5918753 100644 --- a/interfaces/wonder_stuff_render_environment_jsdom_src.IJSDOMConfiguration.html +++ b/interfaces/wonder_stuff_render_environment_jsdom_src.IJSDOMConfiguration.html @@ -1,11 +1,11 @@ IJSDOMConfiguration | wonder-stuff

    Interface IJSDOMConfiguration

    Configuration for a JSDOM environment.

    -

    Hierarchy

    • IJSDOMConfiguration

    Implemented by

    Accessors

    registrationCallbackName +

    Hierarchy

    • IJSDOMConfiguration

    Implemented by

    Accessors

    registrationCallbackName

    Methods

    afterEnvSetup getFileList getResourceLoader

    Accessors

    registrationCallbackName

    Methods

    afterEnvSetup

    Methods

    afterEnvSetup

    • Perform any additional environment setup.

      This method gets access to the actual environment in which code will execute. Be careful what you do.

      Parameters

      • url: string

        The URL that is to be rendered.

        @@ -13,7 +13,7 @@ render operation.

      • Optional vmContext: any

        The actual environment that is being setup.

      Returns Promise<undefined | null | ICloseable>

      A promise that the additional setup is done.

      -

    getFileList

    getFileList

    • Get the list of file URLs to retrieve and execute for the given request.

      Parameters

      • url: string

        The URL that is to be rendered.

      • renderAPI: RenderAPI

        An API of utilities for assisting with the render operation.

        @@ -22,11 +22,11 @@
          • (url): undefined | null | Promise<Buffer>

          • Parameters

            • url: string

            Returns undefined | null | Promise<Buffer>

      Returns Promise<string[]>

      An ordered array of absolute URLs for the JavaScript files that are to be executed. These are exectued in the same order as the array.

      -

    getResourceLoader

    getResourceLoader

    • Get a JSDOM resource loader for the given render request.

      Parameters

      • url: string

        The URL that is to be rendered.

      • renderAPI: RenderAPI

        An API of utilities for assisting with the render operation.

      Returns CloseableResourceLoader

      A ResourceLoader instance for use with JSDOM that can optionally have a close() method, which will be invoked when the render completes.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/wonder_stuff_render_server_src.AbortablePromise.html b/interfaces/wonder_stuff_render_server_src.AbortablePromise.html index da01f696..bac73963 100644 --- a/interfaces/wonder_stuff_render_server_src.AbortablePromise.html +++ b/interfaces/wonder_stuff_render_server_src.AbortablePromise.html @@ -1,11 +1,11 @@ AbortablePromise | wonder-stuff

    Interface AbortablePromise<T>

    A promise that has an abort() method.

    -

    Type Parameters

    • T

    Hierarchy

    • Promise<T>
      • AbortablePromise

    Properties

    [toStringTag] +

    Type Parameters

    • T

    Hierarchy

    • Promise<T>
      • AbortablePromise

    Properties

    [toStringTag] abort aborted

    Methods

    catch finally then -

    Properties

    Readonly [toStringTag]

    [toStringTag]: string

    abort

    abort: (() => void)

    Type declaration

      • (): void

      • Returns void

    aborted

    aborted: boolean

    Methods

    catch

    • Attaches a callback for only the rejection of the Promise.

      +

    Properties

    Readonly [toStringTag]

    [toStringTag]: string

    abort

    abort: (() => void)

    Type declaration

      • (): void

      • Returns void

    aborted

    aborted: boolean

    Methods

    catch

    • Attaches a callback for only the rejection of the Promise.

      Type Parameters

      • TResult = never

      Parameters

      • Optional onrejected: null | ((reason) => TResult | PromiseLike<TResult>)

        The callback to execute when the Promise is rejected.

      Returns Promise<T | TResult>

      A Promise for the completion of the callback.

    finally

    • Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The diff --git a/interfaces/wonder_stuff_render_server_src.CustomErrorHandlerFn.html b/interfaces/wonder_stuff_render_server_src.CustomErrorHandlerFn.html index 5eee7325..6e83ddca 100644 --- a/interfaces/wonder_stuff_render_server_src.CustomErrorHandlerFn.html +++ b/interfaces/wonder_stuff_render_server_src.CustomErrorHandlerFn.html @@ -4,4 +4,4 @@

    Returns undefined | null | ErrorResult | Promise<ErrorResult>

    An error result or the promise of an error result to be returned for the error, or, null if the original error is to be given.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/wonder_stuff_render_server_src.ICloseable.html b/interfaces/wonder_stuff_render_server_src.ICloseable.html index d5548947..4e42e76e 100644 --- a/interfaces/wonder_stuff_render_server_src.ICloseable.html +++ b/interfaces/wonder_stuff_render_server_src.ICloseable.html @@ -1,4 +1,4 @@ ICloseable | wonder-stuff

    Interface ICloseable

    A thing that can be closed.

    -

    Hierarchy

    • ICloseable

    Properties

    close? +

    Hierarchy

    • ICloseable

    Properties

    close?

    Properties

    Optional Readonly close

    close?: (() => void | Promise<void>)

    Type declaration

      • (): void | Promise<void>

      • Close the closeable.

        -

        Returns void | Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void | Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/wonder_stuff_render_server_src.IRenderEnvironment.html b/interfaces/wonder_stuff_render_server_src.IRenderEnvironment.html index fd5c3fea..c6222e79 100644 --- a/interfaces/wonder_stuff_render_server_src.IRenderEnvironment.html +++ b/interfaces/wonder_stuff_render_server_src.IRenderEnvironment.html @@ -3,7 +3,7 @@ standalong (as per the old react-render-server), or more complex rendering strategies where some amount of the rendering environment state is shared across renders.

    -

    Hierarchy

    • IRenderEnvironment

    Implemented by

    Methods

    render +

    Hierarchy

    • IRenderEnvironment

    Implemented by

    Methods

    render

    Methods

    render

    • Generate a render result for the given url.

      Parameters

      • url: string

        The URL that is to be rendered. This is always relative to the host and so does not contain protocol, hostname, nor port @@ -13,4 +13,4 @@

      Returns Promise<RenderResult>

      The result of the render that is to be returned by the gateway service as the response to the render request. This includes the body of the response and the status code information.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/wonder_stuff_render_server_src.TraceCallback.html b/interfaces/wonder_stuff_render_server_src.TraceCallback.html index 0ae792c4..f12c9644 100644 --- a/interfaces/wonder_stuff_render_server_src.TraceCallback.html +++ b/interfaces/wonder_stuff_render_server_src.TraceCallback.html @@ -3,4 +3,4 @@
  • message: string

    A message to be logged for this trace.

    • Returns ITraceSession

    A trace session that the caller should use to indicate when the session is finished.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/wonder_stuff_server_src.ITraceSession.html b/interfaces/wonder_stuff_server_src.ITraceSession.html index a78afd40..6d719258 100644 --- a/interfaces/wonder_stuff_server_src.ITraceSession.html +++ b/interfaces/wonder_stuff_server_src.ITraceSession.html @@ -1,18 +1,18 @@ ITraceSession | wonder-stuff

    Interface ITraceSession

    A trace session that has been started.

    -

    Hierarchy

    • ITraceSession

    Accessors

    action +

    Hierarchy

    • ITraceSession

    Accessors

    action

    Methods

    addLabel end

    Accessors

    action

    Methods

    addLabel

    Methods

    addLabel

    • Add a label to the trace session.

      Adds a key-value pair as a label to the trace span and metadata to the logged output. Both the name and value may be truncated in the trace according to hosting configuration. The value will be coerced to a string in tracing if it isn't one already.

      -

      Type Parameters

      • T

      Parameters

      • name: string
      • value: T

      Returns void

    end

    end

    • End the trace session.

      It the session were opened with a Google Cloud tracer, this will also end the associated tracer span.

      Parameters

      • Optional info: TraceSessionInfo

        Additional information to modify the logged session info. This can be used to provide a different level at which to log the session (default is "debug"). All other fields are used to add metadata to the logged session.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/wonder_stuff_core_src.html b/modules/wonder_stuff_core_src.html index edca52cf..9615a258 100644 --- a/modules/wonder_stuff_core_src.html +++ b/modules/wonder_stuff_core_src.html @@ -1,4 +1,4 @@ -wonder-stuff-core/src | wonder-stuff

    Module wonder-stuff-core/src

    Index

    Classes

    KindError +wonder-stuff-core/src | wonder-stuff

    Module wonder-stuff-core/src

    Index

    Classes

    KindError UnreachableCaseError

    Type Aliases

    Metadata MetadataArray diff --git a/modules/wonder_stuff_i18n_src.html b/modules/wonder_stuff_i18n_src.html index b94d523e..c2535c27 100644 --- a/modules/wonder_stuff_i18n_src.html +++ b/modules/wonder_stuff_i18n_src.html @@ -1,4 +1,4 @@ -wonder-stuff-i18n/src | wonder-stuff

    Module wonder-stuff-i18n/src

    Index

    Classes

    I18nPlugin +wonder-stuff-i18n/src | wonder-stuff

    Module wonder-stuff-i18n/src

    Index

    Classes

    I18nPlugin

    Type Aliases

    ExtractedString TranslatedLocaleStrings

    Functions

    extractStrings diff --git a/modules/wonder_stuff_render_environment_jsdom_src.html b/modules/wonder_stuff_render_environment_jsdom_src.html index 4e888094..ef9fb6f8 100644 --- a/modules/wonder_stuff_render_environment_jsdom_src.html +++ b/modules/wonder_stuff_render_environment_jsdom_src.html @@ -1,4 +1,4 @@ -wonder-stuff-render-environment-jsdom/src | wonder-stuff

    Module wonder-stuff-render-environment-jsdom/src

    Index

    Classes

    Configuration +wonder-stuff-render-environment-jsdom/src | wonder-stuff

    Module wonder-stuff-render-environment-jsdom/src

    Index

    Classes

    Configuration Environment FileResourceLoader ResourceLoader diff --git a/modules/wonder_stuff_render_server_src.Requests.html b/modules/wonder_stuff_render_server_src.Requests.html index 457d5b19..d05ed2a3 100644 --- a/modules/wonder_stuff_render_server_src.Requests.html +++ b/modules/wonder_stuff_render_server_src.Requests.html @@ -1,3 +1,3 @@ -Requests | wonder-stuff

    Namespace Requests

    Index

    Variables

    DefaultRequestOptions +Requests | wonder-stuff

    Namespace Requests

    Index

    Variables

    DefaultRequestOptions

    Functions

    request

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/wonder_stuff_render_server_src.html b/modules/wonder_stuff_render_server_src.html index 37376754..70babfac 100644 --- a/modules/wonder_stuff_render_server_src.html +++ b/modules/wonder_stuff_render_server_src.html @@ -1,4 +1,4 @@ -wonder-stuff-render-server/src | wonder-stuff

    Module wonder-stuff-render-server/src

    Index

    Namespaces

    Requests +wonder-stuff-render-server/src | wonder-stuff

    Module wonder-stuff-render-server/src

    Index

    Namespaces

    Requests

    Interfaces

    AbortablePromise CustomErrorHandlerFn ICloseable diff --git a/modules/wonder_stuff_sentry_src.html b/modules/wonder_stuff_sentry_src.html index a874ce98..1e86bfa4 100644 --- a/modules/wonder_stuff_sentry_src.html +++ b/modules/wonder_stuff_sentry_src.html @@ -1,4 +1,4 @@ -wonder-stuff-sentry/src | wonder-stuff

    Module wonder-stuff-sentry/src

    Index

    Classes

    KindErrorData +wonder-stuff-sentry/src | wonder-stuff

    Module wonder-stuff-sentry/src

    Index

    Classes

    KindErrorData KindSentryError

    Type Aliases

    KindErrorDataOptions SentryContext diff --git a/modules/wonder_stuff_server_src.html b/modules/wonder_stuff_server_src.html index ad768ba0..afdeb5af 100644 --- a/modules/wonder_stuff_server_src.html +++ b/modules/wonder_stuff_server_src.html @@ -1,4 +1,4 @@ -wonder-stuff-server/src | wonder-stuff

    Module wonder-stuff-server/src

    Index

    Enumerations

    Runtime +wonder-stuff-server/src | wonder-stuff

    Module wonder-stuff-server/src

    Index

    Enumerations

    Runtime

    Interfaces

    ITraceSession

    Type Aliases

    LogLevel Logger diff --git a/modules/wonder_stuff_testing_src.html b/modules/wonder_stuff_testing_src.html index edb634de..0a6047a1 100644 --- a/modules/wonder_stuff_testing_src.html +++ b/modules/wonder_stuff_testing_src.html @@ -1,3 +1,3 @@ -wonder-stuff-testing/src | wonder-stuff

    Module wonder-stuff-testing/src

    Index

    Namespaces

    jest +wonder-stuff-testing/src | wonder-stuff

    Module wonder-stuff-testing/src

    Index

    Namespaces

    jest

    Functions

    dataFactoryFor

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/wonder_stuff_testing_src.jest.html b/modules/wonder_stuff_testing_src.jest.html index 5d6f016e..77f9f1f3 100644 --- a/modules/wonder_stuff_testing_src.jest.html +++ b/modules/wonder_stuff_testing_src.jest.html @@ -1,4 +1,4 @@ -jest | wonder-stuff

    Namespace jest

    Index

    Functions

    afterEachRestoreEnv +jest | wonder-stuff

    Namespace jest

    Index

    Functions

    afterEachRestoreEnv isolateModules wait

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/wonder_stuff_core_src.Metadata.html b/types/wonder_stuff_core_src.Metadata.html index 57e6756a..a62e479a 100644 --- a/types/wonder_stuff_core_src.Metadata.html +++ b/types/wonder_stuff_core_src.Metadata.html @@ -1,2 +1,2 @@ Metadata | wonder-stuff

    Type alias Metadata

    Metadata: {
        [name: string]: Metadata | MetadataPrimitive | MetadataArray<MetadataPrimitive | Metadata>;
    }

    A collection of data.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/wonder_stuff_core_src.MetadataArray.html b/types/wonder_stuff_core_src.MetadataArray.html index de93ad23..b9518287 100644 --- a/types/wonder_stuff_core_src.MetadataArray.html +++ b/types/wonder_stuff_core_src.MetadataArray.html @@ -1 +1 @@ -MetadataArray | wonder-stuff

    Type alias MetadataArray<T>

    MetadataArray<T>: (T | MetadataArray<T>)[]

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +MetadataArray | wonder-stuff

    Type alias MetadataArray<T>

    MetadataArray<T>: (T | MetadataArray<T>)[]

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/wonder_stuff_core_src.MetadataPrimitive.html b/types/wonder_stuff_core_src.MetadataPrimitive.html index 32fabaef..867c6c5e 100644 --- a/types/wonder_stuff_core_src.MetadataPrimitive.html +++ b/types/wonder_stuff_core_src.MetadataPrimitive.html @@ -1 +1 @@ -MetadataPrimitive | wonder-stuff

    Type alias MetadataPrimitive

    MetadataPrimitive: string | number | boolean | null | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +MetadataPrimitive | wonder-stuff

    Type alias MetadataPrimitive

    MetadataPrimitive: string | number | boolean | null | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/wonder_stuff_core_src.Mutable.html b/types/wonder_stuff_core_src.Mutable.html index 8e375293..ee2692af 100644 --- a/types/wonder_stuff_core_src.Mutable.html +++ b/types/wonder_stuff_core_src.Mutable.html @@ -1,2 +1,2 @@ Mutable | wonder-stuff

    Type alias Mutable<T>

    Mutable<T>: {
        -readonly [P in keyof T]: T[P]
    }

    Make a read-only type mutable.

    -

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/wonder_stuff_core_src.SecretString.html b/types/wonder_stuff_core_src.SecretString.html index ea45a9ed..b1e98a31 100644 --- a/types/wonder_stuff_core_src.SecretString.html +++ b/types/wonder_stuff_core_src.SecretString.html @@ -1,4 +1,4 @@ SecretString | wonder-stuff

    Type alias SecretString

    SecretString: {
        [opaque]: "Secret";
    }

    A secret that is a string.

    This opaque type makes it clearer when secrets are being used and enforces the need for explicit casting if they must be used as a string.

    -

    Type declaration

    • Readonly [opaque]: "Secret"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • Readonly [opaque]: "Secret"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/wonder_stuff_core_src.Secrets.html b/types/wonder_stuff_core_src.Secrets.html index a514df13..fa2db925 100644 --- a/types/wonder_stuff_core_src.Secrets.html +++ b/types/wonder_stuff_core_src.Secrets.html @@ -1,2 +1,2 @@ Secrets | wonder-stuff

    Type alias Secrets

    Secrets: {
        [key: string]: SecretString;
    }

    A collection of secrets keyed by their names.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/wonder_stuff_i18n_src.ExtractedString.html b/types/wonder_stuff_i18n_src.ExtractedString.html index e9db0308..1b658d04 100644 --- a/types/wonder_stuff_i18n_src.ExtractedString.html +++ b/types/wonder_stuff_i18n_src.ExtractedString.html @@ -1 +1 @@ -ExtractedString | wonder-stuff

    Type alias ExtractedString

    ExtractedString: {
        comments: string[];
        endOffset: number;
        linePos: number;
        msgids: string[];
        startOffset: number;
        type: string;
    }

    Type declaration

    • comments: string[]
    • endOffset: number
    • linePos: number
    • msgids: string[]
    • startOffset: number
    • type: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ExtractedString | wonder-stuff

    Type alias ExtractedString

    ExtractedString: {
        comments: string[];
        endOffset: number;
        linePos: number;
        msgids: string[];
        startOffset: number;
        type: string;
    }

    Type declaration

    • comments: string[]
    • endOffset: number
    • linePos: number
    • msgids: string[]
    • startOffset: number
    • type: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/wonder_stuff_i18n_src.TranslatedLocaleStrings.html b/types/wonder_stuff_i18n_src.TranslatedLocaleStrings.html index 6695bee3..7739fc37 100644 --- a/types/wonder_stuff_i18n_src.TranslatedLocaleStrings.html +++ b/types/wonder_stuff_i18n_src.TranslatedLocaleStrings.html @@ -1 +1 @@ -TranslatedLocaleStrings | wonder-stuff

    Type alias TranslatedLocaleStrings

    TranslatedLocaleStrings: {
        [msgid: string]: string | {
            lang: string;
            messages: string[];
        };
    }

    Type declaration

    • [msgid: string]: string | {
          lang: string;
          messages: string[];
      }

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +TranslatedLocaleStrings | wonder-stuff

    Type alias TranslatedLocaleStrings

    TranslatedLocaleStrings: {
        [msgid: string]: string | {
            lang: string;
            messages: string[];
        };
    }

    Type declaration

    • [msgid: string]: string | {
          lang: string;
          messages: string[];
      }

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/wonder_stuff_render_server_src.AmbiguousError.html b/types/wonder_stuff_render_server_src.AmbiguousError.html index 148e472b..6fc06618 100644 --- a/types/wonder_stuff_render_server_src.AmbiguousError.html +++ b/types/wonder_stuff_render_server_src.AmbiguousError.html @@ -1,3 +1,3 @@ AmbiguousError | wonder-stuff

    Type alias AmbiguousError

    AmbiguousError: SimplifiedError | string | {
        error?: AmbiguousError;
        message?: string;
        name?: string;
        response?: {
            error?: string;
        };
        stack?: string;
    } | Error

    Represents an error when we don't really know how it is structured.

    Use extractError to turn this into a SimplifiedError representation.

    -

    Type declaration

    • Optional error?: AmbiguousError
    • Optional message?: string
    • Optional name?: string
    • Optional response?: {
          error?: string;
      }
      • Optional error?: string
    • Optional stack?: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • Optional error?: AmbiguousError
    • Optional message?: string
    • Optional name?: string
    • Optional response?: {
          error?: string;
      }
      • Optional error?: string
    • Optional stack?: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/wonder_stuff_render_server_src.ErrorResult.html b/types/wonder_stuff_render_server_src.ErrorResult.html index 356ad251..4dc573f4 100644 --- a/types/wonder_stuff_render_server_src.ErrorResult.html +++ b/types/wonder_stuff_render_server_src.ErrorResult.html @@ -1,4 +1,4 @@ ErrorResult | wonder-stuff

    Type alias ErrorResult

    ErrorResult: {
        body: string;
        headers: ResponseHeaders;
    }

    The result of an error handling operation.

    Type declaration

    • Readonly body: string

      The body of the response that is to be sent back from the gateway.

    • Readonly headers: ResponseHeaders

      Headers to be attached to the response.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/wonder_stuff_render_server_src.RenderAPI.html b/types/wonder_stuff_render_server_src.RenderAPI.html index 7f7dc448..4262ba1b 100644 --- a/types/wonder_stuff_render_server_src.RenderAPI.html +++ b/types/wonder_stuff_render_server_src.RenderAPI.html @@ -4,4 +4,4 @@ set based on their access (even if they don't exist).

  • Readonly logger: Logger

    A logger to use for logging during the render operation.

  • Readonly trace: TraceCallback

    Callback to start a trace session for tracing an operation.

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/wonder_stuff_render_server_src.RenderGatewayOptions.html b/types/wonder_stuff_render_server_src.RenderGatewayOptions.html index e80de2f8..89bc1902 100644 --- a/types/wonder_stuff_render_server_src.RenderGatewayOptions.html +++ b/types/wonder_stuff_render_server_src.RenderGatewayOptions.html @@ -20,4 +20,4 @@
  • Optional Readonly uncaughtRenderErrorHandler?: CustomErrorHandlerFn

    Handler that will be invoked if a render request causes an exception.

    This provides the running server with an opportunity to override the default uncaught error response and provide a more friendly message.

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/wonder_stuff_render_server_src.RenderResult.html b/types/wonder_stuff_render_server_src.RenderResult.html index 59e4a07e..a4fc75e7 100644 --- a/types/wonder_stuff_render_server_src.RenderResult.html +++ b/types/wonder_stuff_render_server_src.RenderResult.html @@ -2,4 +2,4 @@

    Type declaration

    • Readonly body: string

      The body of the response that is to be sent back from the gateway.

    • Readonly headers: ResponseHeaders

      Headers to be attached to the response.

    • Readonly status: number

      The HTTP status code.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/wonder_stuff_render_server_src.Request.html b/types/wonder_stuff_render_server_src.Request.html index 8d0b7bfb..9712ffa7 100644 --- a/types/wonder_stuff_render_server_src.Request.html +++ b/types/wonder_stuff_render_server_src.Request.html @@ -1,2 +1,2 @@ Request | wonder-stuff

    Type alias Request

    Request: RequestWithLog<ExpressRequest>

    The request type that we use with express.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/wonder_stuff_render_server_src.RequestOptions.html b/types/wonder_stuff_render_server_src.RequestOptions.html index 55491474..f55370c9 100644 --- a/types/wonder_stuff_render_server_src.RequestOptions.html +++ b/types/wonder_stuff_render_server_src.RequestOptions.html @@ -34,4 +34,4 @@
  • allow retry if err.crossDomain is truthy
  • Readonly timeout: number | Timeouts

    Time to wait in milliseconds before a request times out.

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/wonder_stuff_render_server_src.Response.html b/types/wonder_stuff_render_server_src.Response.html index 80906349..4fc7be72 100644 --- a/types/wonder_stuff_render_server_src.Response.html +++ b/types/wonder_stuff_render_server_src.Response.html @@ -1,2 +1,2 @@ Response | wonder-stuff

    Type alias Response

    Response: ExpressResponse

    The response type that we use with express.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/wonder_stuff_render_server_src.SimplifiedError.html b/types/wonder_stuff_render_server_src.SimplifiedError.html index da8deb90..aa163873 100644 --- a/types/wonder_stuff_render_server_src.SimplifiedError.html +++ b/types/wonder_stuff_render_server_src.SimplifiedError.html @@ -3,4 +3,4 @@ In some circumstances, this will match the stack property.

  • Optional Readonly props?: {
        [key: string]: string | number | boolean;
    }

    Additional properties that the source error had.

    • [key: string]: string | number | boolean
  • Optional Readonly stack?: string

    The error's stack, if it has one.

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/wonder_stuff_render_server_src.Timeouts.html b/types/wonder_stuff_render_server_src.Timeouts.html index 9c58554f..47067a98 100644 --- a/types/wonder_stuff_render_server_src.Timeouts.html +++ b/types/wonder_stuff_render_server_src.Timeouts.html @@ -1,4 +1,4 @@ Timeouts | wonder-stuff

    Type alias Timeouts

    Timeouts: {
        deadline?: number;
        response?: number;
    }

    Timeouts for a request.

    Type declaration

    • Optional deadline?: number

      The total time the request is allowed to take before it times out.

    • Optional response?: number

      The time to wait for a response before a request times out.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/wonder_stuff_sentry_src.KindErrorDataOptions.html b/types/wonder_stuff_sentry_src.KindErrorDataOptions.html index eda4271d..4b358bde 100644 --- a/types/wonder_stuff_sentry_src.KindErrorDataOptions.html +++ b/types/wonder_stuff_sentry_src.KindErrorDataOptions.html @@ -4,4 +4,4 @@
  • Readonly concatenatedMessageTagName: string

    The name to use for the Sentry tag that contains the concatenated error.

  • Readonly groupByTagName: string

    The name to use for the Sentry tag that indicates the grouping string.

  • Readonly kindTagName: string

    The name to use for the Sentry tag that indicates the error kind.

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/wonder_stuff_sentry_src.SentryContext.html b/types/wonder_stuff_sentry_src.SentryContext.html index 9ab1a936..2fc98f2a 100644 --- a/types/wonder_stuff_sentry_src.SentryContext.html +++ b/types/wonder_stuff_sentry_src.SentryContext.html @@ -1,3 +1,3 @@ SentryContext | wonder-stuff

    Type alias SentryContext

    SentryContext: Metadata

    A context object for a Sentry event.

    The key of each item is the name of a field within the context.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/wonder_stuff_sentry_src.SentryData.html b/types/wonder_stuff_sentry_src.SentryData.html index ecddb091..225d1862 100644 --- a/types/wonder_stuff_sentry_src.SentryData.html +++ b/types/wonder_stuff_sentry_src.SentryData.html @@ -7,4 +7,4 @@ get grouped.

  • tags: SentryTags

    This is passed to setTags on the sentry scope. Tags help categorize things.

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/wonder_stuff_sentry_src.SentryFingerprint.html b/types/wonder_stuff_sentry_src.SentryFingerprint.html index dd8133c8..50f9ab3f 100644 --- a/types/wonder_stuff_sentry_src.SentryFingerprint.html +++ b/types/wonder_stuff_sentry_src.SentryFingerprint.html @@ -1,3 +1,3 @@ SentryFingerprint | wonder-stuff

    Type alias SentryFingerprint

    SentryFingerprint: string[]

    A Sentry fingerprint.

    This is an array of strings.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/wonder_stuff_sentry_src.SentryTags.html b/types/wonder_stuff_sentry_src.SentryTags.html index 6d4dd4b4..59bd5479 100644 --- a/types/wonder_stuff_sentry_src.SentryTags.html +++ b/types/wonder_stuff_sentry_src.SentryTags.html @@ -1,3 +1,3 @@ SentryTags | wonder-stuff

    Type alias SentryTags

    SentryTags: {
        [name: string]: string;
    }

    Tags for a Sentry event.

    The key of each item is the name of the tag.

    -

    Type declaration

    • [name: string]: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • [name: string]: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/wonder_stuff_server_src.LogLevel.html b/types/wonder_stuff_server_src.LogLevel.html index 7f11e24d..1cc835ef 100644 --- a/types/wonder_stuff_server_src.LogLevel.html +++ b/types/wonder_stuff_server_src.LogLevel.html @@ -1,2 +1,2 @@ LogLevel | wonder-stuff

    Type alias LogLevel

    LogLevel: string

    Defines the different log levels.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/wonder_stuff_server_src.Logger.html b/types/wonder_stuff_server_src.Logger.html index 66e29936..12ae2a5d 100644 --- a/types/wonder_stuff_server_src.Logger.html +++ b/types/wonder_stuff_server_src.Logger.html @@ -1,2 +1,2 @@ Logger | wonder-stuff

    Type alias Logger

    Logger: WinstonLogger

    Describes the interface for logging gateway activity.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/wonder_stuff_server_src.RequestWithLog.html b/types/wonder_stuff_server_src.RequestWithLog.html index eb992ba7..1b78b08d 100644 --- a/types/wonder_stuff_server_src.RequestWithLog.html +++ b/types/wonder_stuff_server_src.RequestWithLog.html @@ -1 +1 @@ -RequestWithLog | wonder-stuff

    Type alias RequestWithLog<TReq>

    RequestWithLog<TReq>: TReq & {
        log?: Logger;
    }

    Type Parameters

    • TReq extends Request

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +RequestWithLog | wonder-stuff

    Type alias RequestWithLog<TReq>

    RequestWithLog<TReq>: TReq & {
        log?: Logger;
    }

    Type Parameters

    • TReq extends Request

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/wonder_stuff_server_src.ServerOptions.html b/types/wonder_stuff_server_src.ServerOptions.html index addab564..4b0062a1 100644 --- a/types/wonder_stuff_server_src.ServerOptions.html +++ b/types/wonder_stuff_server_src.ServerOptions.html @@ -13,4 +13,4 @@
  • Readonly name: string

    The name of the server.

  • Readonly port: number

    The port on which the server should listen.

  • Optional Readonly requestAuthentication?: RequestAuthentication

    Configuration information for authenticating requests.

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/wonder_stuff_core_src.Errors.html b/variables/wonder_stuff_core_src.Errors.html index 4fc2b065..0c900926 100644 --- a/variables/wonder_stuff_core_src.Errors.html +++ b/variables/wonder_stuff_core_src.Errors.html @@ -1 +1 @@ -Errors | wonder-stuff

    Variable ErrorsConst

    Errors: Readonly<{
        Internal: "Internal";
        InvalidInput: "InvalidInput";
        InvalidUse: "InvalidUse";
        NotAllowed: "NotAllowed";
        NotFound: "NotFound";
        NotImplemented: "NotImplemented";
        Unauthorized: "Unauthorized";
        Unknown: "Unknown";
    }> = ...

    Type declaration

    • Internal: "Internal"
    • InvalidInput: "InvalidInput"
    • InvalidUse: "InvalidUse"
    • NotAllowed: "NotAllowed"
    • NotFound: "NotFound"
    • NotImplemented: "NotImplemented"
    • Unauthorized: "Unauthorized"
    • Unknown: "Unknown"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Errors | wonder-stuff

    Variable ErrorsConst

    Errors: Readonly<{
        Internal: "Internal";
        InvalidInput: "InvalidInput";
        InvalidUse: "InvalidUse";
        NotAllowed: "NotAllowed";
        NotFound: "NotFound";
        NotImplemented: "NotImplemented";
        Unauthorized: "Unauthorized";
        Unknown: "Unknown";
    }> = ...

    Type declaration

    • Internal: "Internal"
    • InvalidInput: "InvalidInput"
    • InvalidUse: "InvalidUse"
    • NotAllowed: "NotAllowed"
    • NotFound: "NotFound"
    • NotImplemented: "NotImplemented"
    • Unauthorized: "Unauthorized"
    • Unknown: "Unknown"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/wonder_stuff_core_src.Order.html b/variables/wonder_stuff_core_src.Order.html index eac3bb40..8724a89c 100644 --- a/variables/wonder_stuff_core_src.Order.html +++ b/variables/wonder_stuff_core_src.Order.html @@ -1 +1 @@ -Order | wonder-stuff

    Variable OrderConst

    Order: Readonly<{
        CauseFirst: "cause-first";
        ConsequenceFirst: "consequence-first";
    }> = ...

    Type declaration

    • CauseFirst: "cause-first"
    • ConsequenceFirst: "consequence-first"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Order | wonder-stuff

    Variable OrderConst

    Order: Readonly<{
        CauseFirst: "cause-first";
        ConsequenceFirst: "consequence-first";
    }> = ...

    Type declaration

    • CauseFirst: "cause-first"
    • ConsequenceFirst: "consequence-first"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/wonder_stuff_render_server_src.Requests.DefaultRequestOptions.html b/variables/wonder_stuff_render_server_src.Requests.DefaultRequestOptions.html index 30c31bed..2bb2f86c 100644 --- a/variables/wonder_stuff_render_server_src.Requests.DefaultRequestOptions.html +++ b/variables/wonder_stuff_render_server_src.Requests.DefaultRequestOptions.html @@ -1,2 +1,2 @@ DefaultRequestOptions | wonder-stuff

    Variable DefaultRequestOptionsConst

    DefaultRequestOptions: RequestOptions = ...

    The defaults used for request options.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/wonder_stuff_server_src.Errors.html b/variables/wonder_stuff_server_src.Errors.html index b9f24652..3c9b9c1d 100644 --- a/variables/wonder_stuff_server_src.Errors.html +++ b/variables/wonder_stuff_server_src.Errors.html @@ -1 +1 @@ -Errors | wonder-stuff

    Variable ErrorsConst

    Errors: Readonly<{
        Internal: "Internal";
        InvalidInput: "InvalidInput";
        InvalidUse: "InvalidUse";
        NotAllowed: "NotAllowed";
        NotFound: "NotFound";
        NotImplemented: "NotImplemented";
        Service: "Service";
        TransientService: "TransientService";
        Unauthorized: "Unauthorized";
        Unknown: "Unknown";
    }> = ...

    Type declaration

    • Internal: "Internal"
    • InvalidInput: "InvalidInput"
    • InvalidUse: "InvalidUse"
    • NotAllowed: "NotAllowed"
    • NotFound: "NotFound"
    • NotImplemented: "NotImplemented"
    • Service: "Service"
    • TransientService: "TransientService"
    • Unauthorized: "Unauthorized"
    • Unknown: "Unknown"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Errors | wonder-stuff

    Variable ErrorsConst

    Errors: Readonly<{
        Internal: "Internal";
        InvalidInput: "InvalidInput";
        InvalidUse: "InvalidUse";
        NotAllowed: "NotAllowed";
        NotFound: "NotFound";
        NotImplemented: "NotImplemented";
        Service: "Service";
        TransientService: "TransientService";
        Unauthorized: "Unauthorized";
        Unknown: "Unknown";
    }> = ...

    Type declaration

    • Internal: "Internal"
    • InvalidInput: "InvalidInput"
    • InvalidUse: "InvalidUse"
    • NotAllowed: "NotAllowed"
    • NotFound: "NotFound"
    • NotImplemented: "NotImplemented"
    • Service: "Service"
    • TransientService: "TransientService"
    • Unauthorized: "Unauthorized"
    • Unknown: "Unknown"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file