@types/ibm-openapi-validator
Advanced tools
Weekly downloads
Readme
npm install --save @types/ibm-openapi-validator
This package contains type definitions for ibm-openapi-validator (https://github.com/IBM/openapi-validator#readme).
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ibm-openapi-validator.
// Type definitions for ibm-openapi-validator 0.15
// Project: https://github.com/IBM/openapi-validator#readme
// Definitions by: Rifa Achrinza <https://github.com/achrinza>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 3.0
interface validatorResultItem {
path: string;
message: string;
}
interface validatorResult {
errors: [] | [ validatorResultItem ];
warnings: [] | [ validatorResultItem ];
}
/**
* @default false
*/
type validatorParameterDefaultMode = boolean;
/**
* OpenAPI document validator
* @param openApiDoc - OpenAPI document object
* @param defaultMode - If set to true, the validator will ignore the .validaterc file and will use the [configuration defaults](https://github.com/IBM/openapi-validator#default-values).
* @returns Validation results
*/
declare function validator(openApiDoc: {[property: string]: any}, defaultMode?: validatorParameterDefaultMode): Promise<validatorResult>;
export = validator;
These definitions were written by Rifa Achrinza.
FAQs
TypeScript definitions for ibm-openapi-validator
The npm package @types/ibm-openapi-validator receives a total of 527 weekly downloads. As such, @types/ibm-openapi-validator popularity was classified as not popular.
We found that @types/ibm-openapi-validator demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.