Backstage
    Preparing search index...
    • Loads config schema for a Backstage instance.

      Parameters

      • options: (
            | {
                dependencies: string[];
                excludePackageDependencies?: boolean;
                onSchemaError?: (error: ConfigSchemaError) => void;
                packagePaths?: string[];
            }
            | { serialized: JsonObject }
        ) & { noUndeclaredProperties?: boolean }
        • {
              dependencies: string[];
              excludePackageDependencies?: boolean;
              onSchemaError?: (error: ConfigSchemaError) => void;
              packagePaths?: string[];
          }
          • dependencies: string[]
          • OptionalexcludePackageDependencies?: boolean

            Whether to exclude schemas from package dependencies.

            Defaults to false.

          • OptionalonSchemaError?: (error: ConfigSchemaError) => void

            Receives ConfigSchemaError instances and allows TypeScript schema loading to continue. Unresolved types are treated as unconstrained values, while schemas that cannot be generated are omitted.

            Without this callback, TypeScript configuration schema errors are thrown.

          • OptionalpackagePaths?: string[]
        • { serialized: JsonObject }
        • OptionalnoUndeclaredProperties?: boolean

      Returns Promise<ConfigSchema>