Skip to content

Latest commit

 

History

History
61 lines (47 loc) · 1.97 KB

API.md

File metadata and controls

61 lines (47 loc) · 1.97 KB

API

Functions

generateOpenAPITypes(schema, options)TypeScript.NodeArray

Create the TypeScript types declarations from an Open API document

generateJSONSchemaTypes(schema, options)TypeScript.NodeArray

Create the TypeScript types declarations from a JSONSchema document

toSource(nodes)

Returns source from a list of TypeScript statements

generateOpenAPITypes(schema, options) ⇒ TypeScript.NodeArray

Create the TypeScript types declarations from an Open API document

Kind: global function

Param Type
schema JSONSchema.Document
options Object
options.baseName string
options.filterStatuses Array.<number>
options.generateUnusedSchemas boolean
options.camelizeInputs boolean
options.brandedTypes Array.<string>
options.generateRealEnums boolean
options.exportNamespaces boolean
options.requireCleanAPI boolean

generateJSONSchemaTypes(schema, options) ⇒ TypeScript.NodeArray

Create the TypeScript types declarations from a JSONSchema document

Kind: global function

Param Type
schema JSONSchema.Document
options Object
options.name string
options.brandedTypes Array.<string>

toSource(nodes) ⇒

Returns source from a list of TypeScript statements

Kind: global function
Returns: string

Param Type
nodes TypedPropertyDescriptor.NodeArray