validateReSpecConfig
validateReSpecConfig(
config):object
Defined in: packages/render-respec/src/model.ts:106
Validate ReSpec configuration
Parameters
Section titled “Parameters”config
Section titled “config”unknown
Returns
Section titled “Returns”object
authors?
Section titled “authors?”
optionalauthors:object[]
copyrightStart?
Section titled “copyrightStart?”
optionalcopyrightStart:string
editors?
Section titled “editors?”
optionaleditors:object[]
github?
Section titled “github?”
optionalgithub:string
githubAPI?
Section titled “githubAPI?”
optionalgithubAPI:string
group?
Section titled “group?”
optionalgroup:string
license?
Section titled “license?”
optionallicense:string
optionallint:boolean
localBiblio?
Section titled “localBiblio?”
optionallocalBiblio:Record<string,any>
logos?
Section titled “logos?”
optionallogos:object[]
maxTocLevel
Section titled “maxTocLevel”maxTocLevel:
number
previousMaturity?
Section titled “previousMaturity?”
optionalpreviousMaturity:string
previousPublishDate?
Section titled “previousPublishDate?”
optionalpreviousPublishDate:string
publishDate?
Section titled “publishDate?”
optionalpublishDate:string
shortName?
Section titled “shortName?”
optionalshortName:string
specStatus
Section titled “specStatus”specStatus:
"ED"|"FPWD"|"WD"|"CR"|"PR"|"REC"|"NOTE"|"unofficial"
subtitle?
Section titled “subtitle?”
optionalsubtitle:string
optionalwg:string
wgPatentURI?
Section titled “wgPatentURI?”
optionalwgPatentURI:string
wgPublicList?
Section titled “wgPublicList?”
optionalwgPublicList:string
wgURI?
Section titled “wgURI?”
optionalwgURI:string
optionalxref:boolean