You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 7-8.RSVP
Socket
Socket
Sign inDemoInstall

@openapi-generator-plus/typescript-fetch-client-generator

Package Overview
Dependencies
6
Maintainers
0
Versions
132
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@openapi-generator-plus/typescript-fetch-client-generator

An OpenAPI Generator Plus template for a TypeScript API client using Fetch


Version published
Weekly downloads
559
decreased by-25.17%
Maintainers
0
Created
Weekly downloads
 

Readme

Source

TypeScript Fetch Browser API generator for OpenAPI Generator Plus

An OpenAPI Generator Plus template for a TypeScript API client using Fetch in a Browser. For an API client to use in Node applications, see typescript-fetch-node-client-generator.

Using

See the OpenAPI Generator Plus documentation for how to use generator templates.

Config file

The available config file properties are:

Project layout

PropertyTypeDescriptionDefault
relativeSourceOutputPathstringThe path to output generated source code, relative to the output path../ or ./src if npm is specified.

Code style

PropertyTypeDescriptionDefault
constantStyle"allCapsSnake"|"allCaps"|"camelCase"|"pascalCase"The style to use for constant naming."pascalCase"
dateApproach"native"|"string"|"blind-date"Whether to use string for date and time and Date for date-time, or just string, or whether to use blind-date for dates and times.native
legacyUnnamespacedModelSupportbooleanGenerate unnamespaced versions of the models.false
includePolyfillsbooleanInclude polyfills for features that browsers might not support or support well.true

blind-date

The blind-date library provides some typesafety for dates and times as strings in TypeScript. You can configure the generated code using blind-date:

PropertyTypeDescriptionDefault
blindDateBlindDateConfigConfiguration for blind-date.undefined
BlindDateConfig
PropertyTypeDescriptionDefault
dateTimeImplementationstringThe date-time implementation to use; either OffsetDateTimeString or LocalDateTimeString.OffsetDateTimeString

TypeScript

A tsconfig.json file will be output if you specify any of the TypeScript config options.

PropertyTypeDescriptionDefault
typescriptTypeScriptConfigConfiguration for the tsconfig.json file.undefined
TypeScriptConfig
PropertyTypeDescriptionDefault
targetstringThe ECMAScript target version.ES5
libstring[]An array of libs to use in tsconfig.jsonThe appropriate lib for the target + 'DOM'

Packaging

PropertyTypeDescriptionDefault
npmNpmConfigConfiguration for generating an npm package.jsonundefined
NpmConfig
PropertyTypeDescriptionDefault
namestringThe package nametypescript-fetch-api
versionstringThe package version0.0.1
repositorystringThe URL to the package repositoryundefined

Overrides

PropertyTypeDescriptionDefault
customTemplatesstringThe path to a directory containing custom Handlebars templates, relative to the config file. See Customising below.undefined

Customising

This generator supports a customTemplates config file property to specify a directory containing Handlebars templates that will be used to override built-in templates.

Any custom template will have the original template available as a partial named by prefixing the template name with original, and then upper-casing the first letter, e.g. originalModelEnum.

Some of the templates in the generator are designed to support overriding for custom requirements. Please inspect the templates in the templates directory.

Keywords

FAQs

Package last updated on 02 Jul 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc