OpenapiRequestGenerator

---

Import

import { OpenapiRequestGenerator } from "@hyper-fetch/cli"

Source

View the source code

Package

@hyper-fetch/cli

Parameters

class OpenapiRequestGenerator {
  constructor(openapiDocument: any) {};
  generateFile(__namedParameters: { config: { aliases: { api: string; components: string; hooks: string; lib: string; ui: string }; resolvedPaths: { api: string; components: string; cwd: string; hooks: string; lib: string; ui: string }; tsx: boolean }; fileName: string }) => Promise<string>;
  generateRequestsFromSchema() => Promise<{ createSdkFn: string; generatedTypes: string[]; schemaTypes: string; sdkSchema: string }>;
  generateHyperFetchRequest(__namedParameters: { id: string; method: string; path: string; queryParamsRequired?: boolean }, types: Record<string, string>) => string;
  generateMethodMetadata(operation: { method: string; operationId: string; path: string } & Partial<Operation>, exportTypes: ExportedType[]) => { errorType: string; id: string; method: string; path: string; pathParametersType: undefined | string; queryParametersType: undefined | string; queryParamsRequired: boolean; requestBodyType: undefined | string; responseType: string };
  generateRequestInstanceType(__namedParameters: { id: string; path: string; queryParamsRequired?: boolean }, types: Record<string, string>) => string;
  generateTypes(__namedParameters: { errorType: string; id: string; pathParametersType: undefined | string; queryParametersType: undefined | string; requestBodyType: undefined | string; responseType: string }) => GeneratedTypes<string>;
  getSchemaFromUrl(__namedParameters: { config: { aliases: { api: string; components: string; hooks: string; lib: string; ui: string }; resolvedPaths: { api: string; components: string; cwd: string; hooks: string; lib: string; ui: string }; tsx: boolean }; url: string }) => Promise<any>;
  prepareSchema(openapiDocument: Document) => Promise<{ exportedTypes: ExportedType[]; schemaTypes: string }>;
  validateSchema(openapiDocument: Document) => void;
}

Parameters

Name	Type	Description
openapiDocument	any

Methods

validateSchema()

Source

View the source code

Preview

validateSchema(openapiDocument: Document)

Parameters

Parameters

Name	Type	Description
openapiDocument	Document

Returns

void

---

prepareSchema()

Source

View the source code

Preview

prepareSchema(openapiDocument: Document)

Parameters

Parameters

Name	Type	Description
openapiDocument	Document

Returns

Promise<{ exportedTypes: ExportedType[]; schemaTypes: string }>

---

getSchemaFromUrl()

Source

View the source code

Preview

getSchemaFromUrl(__namedParameters: { config: { aliases: { api: string; components: string; hooks: string; lib: string; ui: string }; resolvedPaths: { api: string; components: string; cwd: string; hooks: string; lib: string; ui: string }; tsx: boolean }; url: string })

Parameters

Parameters

Name	Type	Description
__namedParameters	{ config: { aliases: { api: string; components: string; hooks: string; lib: string; ui: string }; resolvedPaths: { api: string; components: string; cwd: string; hooks: string; lib: string; ui: string }; tsx: boolean }; url: string }

Returns

Promise<any>

---

generateTypes()

Source

View the source code

Preview

generateTypes(__namedParameters: { errorType: string; id: string; pathParametersType: undefined | string; queryParametersType: undefined | string; requestBodyType: undefined | string; responseType: string })

Parameters

Parameters

Name	Type	Description
__namedParameters	{ errorType: string; id: string; pathParametersType: undefined | string; queryParametersType: undefined | string; requestBodyType: undefined | string; responseType: string }

Returns

GeneratedTypes<string>

---

generateRequestInstanceType()

Source

View the source code

Preview

generateRequestInstanceType(__namedParameters: { id: string; path: string; queryParamsRequired?: boolean }, types: Record<string, string>)

Parameters

Parameters

Name	Type	Description
__namedParameters	{ id: string; path: string; queryParamsRequired?: boolean }
types	Record<string, string>

Returns

string

---

generateMethodMetadata()

Source

View the source code

Preview

generateMethodMetadata(operation: { method: string; operationId: string; path: string } & Partial<Operation>, exportTypes: ExportedType[])

Parameters

Parameters

Name	Type	Description
operation	{ method: string; operationId: string; path: string } & Partial<Operation>
exportTypes	ExportedType[]

Returns

generateMethodMetadata

Name	Type	Description
errorType	string
id	string
method	string
path	string
pathParametersType	undefined | string
queryParametersType	undefined | string
queryParamsRequired	boolean
requestBodyType	undefined | string
responseType	string

---

generateHyperFetchRequest()

Source

View the source code

Preview

generateHyperFetchRequest(__namedParameters: { id: string; method: string; path: string; queryParamsRequired?: boolean }, types: Record<string, string>)

Parameters

Parameters

Name	Type	Description
__namedParameters	{ id: string; method: string; path: string; queryParamsRequired?: boolean }
types	Record<string, string>

Returns

string

---

generateRequestsFromSchema()

Source

View the source code

Preview

generateRequestsFromSchema()

Returns

Promise<{ createSdkFn: string; generatedTypes: string[]; schemaTypes: string; sdkSchema: string }>

---

generateFile()

Source

View the source code

Preview

generateFile(__namedParameters: { config: { aliases: { api: string; components: string; hooks: string; lib: string; ui: string }; resolvedPaths: { api: string; components: string; cwd: string; hooks: string; lib: string; ui: string }; tsx: boolean }; fileName: string })

Parameters

Parameters

Name	Type	Description
__namedParameters	{ config: { aliases: { api: string; components: string; hooks: string; lib: string; ui: string }; resolvedPaths: { api: string; components: string; cwd: string; hooks: string; lib: string; ui: string }; tsx: boolean }; fileName: string }

Returns

Promise<string>

---