Skip to content
This repository has been archived by the owner on Dec 27, 2024. It is now read-only.

Commit

Permalink
docs: update typescript definition
Browse files Browse the repository at this point in the history
  • Loading branch information
joolfe committed Sep 18, 2022
1 parent 5e92c6d commit 253dec7
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,13 @@ export interface FoldersOption {
separator: string
}

export interface DisabledParamsOptions {
// Default to `false`
includeQuery?: boolean,
// Default to `false`
includeHeader?: boolean
}

export interface Options {
info?: InfoObject,
defaultTag?: string,
Expand All @@ -84,7 +91,8 @@ export interface Options {
replaceVars?: boolean,
additionalVars?: { [key: string]: string },
// Default value 'yaml'
outputFormat?: 'json' | 'yaml'
outputFormat?: 'json' | 'yaml',
disabledParams?: DisabledParamsOptions
}

export default function postmanToOpenApi (input: string, output?: string, options?: Options) : Promise<string>

0 comments on commit 253dec7

Please sign in to comment.