Skip to content

Latest commit

 

History

History
152 lines (92 loc) · 4.37 KB

modules.md

File metadata and controls

152 lines (92 loc) · 4.37 KB

pontx-spec / Exports

pontx-spec

Table of contents

Enumerations

Classes

Type Aliases

Variables

Functions

Type Aliases

ObjectMap

Ƭ ObjectMap<T>: Object

Type parameters

Name
T

Index signature

▪ [key: string]: T

Defined in

pontx-spec/src/utils.ts:4


ResponseObject

Ƭ ResponseObject: Object

Type declaration

Name Type
description? string
headers? OAS2.HeadersObject
schema PontJsonSchema

Defined in

pontx-spec/src/type.ts:15

Variables

PontJsonPointer

Const PontJsonPointer: Object

Type declaration

Name Type
get (json: any, jsonpointer: string) => any
remove (json: any, jsonpointer: string) => any
removeMapKeyBy (json: any, jsonpointer: string, checkRemoveKey: (key: string | number) => boolean) => any
set (json: any, jsonpointer: string, newValue: any) => any
update (json: any, jsonpointer: string, updator: (val: any) => any) => any

Defined in

pontx-spec/src/jsonpointer.ts:163


WithoutModsName

Const WithoutModsName: typeof WithoutModsName

Defined in

pontx-spec/src/type.ts:225

Functions

parsePontSpec2OAS2

parsePontSpec2OAS2(spec): SwaggerObject | { apis: ObjectMap<PontAPI> = spec.apis; basePath: string = spec.basePath; definitions: ObjectMap<PontJsonSchema> = spec.definitions; externalDocs: ExternalDocumentationObject = spec.externalDocs; host: string = spec.host; info: { description: string = spec.description; title: string = spec.title; version: string = spec.version } ; swagger: string = "2.0"; tags: { description: string ; name: string }[] }

Parameters

Name Type
spec PontSpec

Returns

SwaggerObject | { apis: ObjectMap<PontAPI> = spec.apis; basePath: string = spec.basePath; definitions: ObjectMap<PontJsonSchema> = spec.definitions; externalDocs: ExternalDocumentationObject = spec.externalDocs; host: string = spec.host; info: { description: string = spec.description; title: string = spec.title; version: string = spec.version } ; swagger: string = "2.0"; tags: { description: string ; name: string }[] }

Defined in

pontx-spec/src/parse.ts:6


removeMapKeys

removeMapKeys<T>(obj, checkRemoveKey): T

Type parameters

Name Type
T extends ObjectMap<any>

Parameters

Name Type
obj T
checkRemoveKey (key: string) => boolean

Returns

T

Defined in

pontx-spec/src/utils.ts:117