@stoplight/types
Common typings for the Stoplight ecosystem.
Installation
Supported in modern browsers and node.
yarn add -D @stoplight/typesContributing
Clone repo.
Create / checkout feature/{name}, chore/{name}, or fix/{name} branch.
Install deps: yarn.
Make your changes.
Run tests: yarn test.prod.
Stage relevant files to git.
Commit: yarn commit. NOTE: Commits that don't follow the conventional format will be rejected. yarn commit creates this format for you, or you can put it together manually and then do a regular git commit.
Push: git push.
Open PR targeting the next branch.
Type aliases
DeepPartial
DeepPartial: object
DeepReadonly
DeepReadonly: DeepReadonly<T>
DiagnosticTag
DiagnosticTag: string
Dictionary
Dictionary: object
DictionaryValues
DictionaryValues: DictionaryValues<T>
DocumentUri
DocumentUri: string
ExtendedHttpMethod
Extended
HttpMethod: HttpMethod | "copy" | "link" | "unlink" | "purge" | "lock" | "unlock"
GetJsonPathForPosition
GetJsonPathForPosition: function
GetLocationForJsonPath
GetLocationForJsonPath: function
Type declaration
Parameters
Optional closest: boolean
Returns ILocation
|
undefined
HttpMethod
HttpMethod: "get" | "post" | "put" | "patch" | "delete" | "head" | "options"
Omit
Omit: Pick < T , Exclude < keyof T , K > >
Opaque
Opaque: T & object
Optional
Optional: T | undefined
Primitive
Primitive: string | number | boolean | undefined | null
Segment
Segment: string | number
SourceMapParser
SourceMapParser: function
Legend
Module Object literal Variable Function Function with type parameter Index signature Type alias
Enumeration Enumeration member Property Method
Interface Interface with type parameter Constructor Property Method Index signature
Class Class with type parameter Constructor Property Method Accessor Index signature
Inherited constructor Inherited property Inherited method Inherited accessor
Protected property Protected method Protected accessor
Private property Private method Private accessor
Static property Static method
Like Partial but recursive