Documentation - v7.8.0
    Preparing search index...

    Function validateAndBuildConfiguration

    • Validates a raw init configuration object against a ConfigurationSchema and builds the corresponding InferredConfig. Use this to derive a schema-driven configuration builder for a package (e.g. validateAndBuildRumConfiguration) instead of writing per-field validation by hand.

      Type Parameters

      Parameters

      • initConfig: unknown

        The raw, untrusted configuration object provided by the SDK consumer.

      • schema: S

        The ConfigurationSchema describing every field to validate.

      • display: Display

        Optional error reporter; when provided, validation failures are reported through display.error with a message naming the offending field.

      Returns InferredConfig<S> | undefined

      The validated, defaulted configuration, or undefined if initConfig is missing or a required/strict field failed validation.