@scalar/api-reference
Version:
Generate beautiful API references from OpenAPI documents
16 lines • 995 B
TypeScript
import type { ApiReferenceConfiguration } from '@scalar/types/api-reference';
import type { DiscriminatorObject, SchemaObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
/** Extract the type of properties */
type Properties = NonNullable<Extract<SchemaObject, {
type: 'object';
}>['properties']>;
type Options = Partial<Pick<ApiReferenceConfiguration, 'orderSchemaPropertiesBy' | 'orderRequiredPropertiesFirst'> & {
hideReadOnly: boolean;
hideWriteOnly: boolean;
}>;
/** Take a list of property names and reduce it back into an object */
export declare const reduceNamesToObject: (names: string[], properties: Properties) => Properties;
/** Sort property names in an object schema */
export declare const sortPropertyNames: (schema: SchemaObject, discriminator?: DiscriminatorObject, { hideReadOnly, hideWriteOnly, orderSchemaPropertiesBy, orderRequiredPropertiesFirst, }?: Options) => string[];
export {};
//# sourceMappingURL=sort-property-names.d.ts.map