schema-components - v3.7.0
    Preparing search index...

    Interface StreamRenderOptions<T, Ref, Mode>

    Options accepted by the streaming HTML renderers (renderToHtmlChunks, renderToHtmlStream, renderToHtmlReadable).

    The generic parameters mirror <SchemaComponent> so a typed schema argument drives typed value, ref, and fields options.

    interface StreamRenderOptions<
        T = unknown,
        Ref extends string | undefined = undefined,
        Mode extends SchemaIoSide = "output",
    > {
        value?: InferSchemaValue<T, Ref, Mode>;
        ref?: Ref;
        fields?: InferFields<T, Ref>;
        meta?: SchemaMeta;
        readOnly?: boolean;
        writeOnly?: boolean;
        description?: string;
        resolver?: HtmlResolver;
    }

    Type Parameters

    • T = unknown
    • Ref extends string | undefined = undefined
    • Mode extends SchemaIoSide = "output"
    Index

    Properties

    value? ref? fields? meta? readOnly? writeOnly? description? resolver?

    Properties

    value?: InferSchemaValue<T, Ref, Mode>

    The data value to render. Typed against InferredValue<T, Ref, undefined, Mode> so a typed schema argument drives the rendered value's shape.

    ref?: Ref

    For OpenAPI: a ref string like "#/components/schemas/User".

    fields?: InferFields<T, Ref>

    Per-field meta overrides — nested object mirroring schema shape. Typed against InferFields so a typed schema argument drives autocomplete on the override map.

    meta?: SchemaMeta

    Meta overrides applied to the root schema.

    readOnly?: boolean

    Force all fields read-only.

    writeOnly?: boolean

    Force all fields as inputs.

    description?: string

    Root description.

    resolver?: HtmlResolver

    Custom HTML resolver. Falls back to defaultHtmlResolver.

    Settings

    Member Visibility

    On This Page

    Properties