@scalar/api-client
Version:
the open source API testing client
23 lines • 852 B
TypeScript
/**
* Represents the extracted details from a Postman collection.
* Used to display collection metadata in the command palette import UI.
*/
export type PostmanDocumentDetails = {
/** The document format type. */
type: string;
/** The name of the Postman collection. */
title: string;
/** The version of the Postman collection. */
version: string;
};
/**
* Extracts document details from a Postman collection JSON string.
*
* We parse and validate in a single pass to avoid the performance cost
* of parsing the JSON twice.
*
* @param content - The JSON string representing the Postman collection
* @returns The collection details if valid, null otherwise
*/
export declare const getPostmanDocumentDetails: (content: string) => PostmanDocumentDetails | null;
//# sourceMappingURL=get-postman-document-details.d.ts.map