Skip to Content
@jetio/schema-builder docs are live 🎉
API ReferenceRefBuilder

RefBuilder

MethodParametersReturnsDescription
.base(url)stringRefBuilderSet base URL
.$defs(name)stringRefBuilderAdd /$defs/name
.definitions(name)stringRefBuilderAdd /definitions/name
.properties(name)stringRefBuilderAdd /properties/name
.patternProperties(pattern)stringRefBuilderAdd /patternProperties/pattern
.additionalProperties()—RefBuilderAdd /additionalProperties
.unevaluatedProperties()—RefBuilderAdd /unevaluatedProperties
.propertyNames()—RefBuilderAdd /propertyNames
.dependentSchemas(prop)stringRefBuilderAdd /dependentSchemas/prop
.dependencies(prop)stringRefBuilderAdd /dependencies/prop
.items(index?)number?RefBuilderAdd /items or /items/index
.prefixItems(index)numberRefBuilderAdd /prefixItems/index
.additionalItems()—RefBuilderAdd /additionalItems
.unevaluatedItems()—RefBuilderAdd /unevaluatedItems
.contains()—RefBuilderAdd /contains
.allOf(index)numberRefBuilderAdd /allOf/index
.anyOf(index)numberRefBuilderAdd /anyOf/index
.oneOf(index)numberRefBuilderAdd /oneOf/index
.not()—RefBuilderAdd /not
.if()—RefBuilderAdd /if
.then()—RefBuilderAdd /then
.else()—RefBuilderAdd /else
.elseIf(index)numberRefBuilderAdd /elseIf/index
.anchor(name)stringRefBuilderSet anchor reference
.dynamicAnchor(name)stringRefBuilderSet dynamic anchor reference
.segment(path)stringRefBuilderAdd custom path segment
.reset()—RefBuilderClear path back to base
.extend()—RefBuilderClone RefBuilder
.chain()—RefBuilderReturn self (for external composition)
.build()—stringReturn the reference string
.toString()—stringAlias for build()
Last updated on