Skip to content

Latest commit

 

History

History
33 lines (19 loc) · 851 Bytes

README.md

File metadata and controls

33 lines (19 loc) · 851 Bytes

Communibase administration types generator

CLI for generating a communibase.d.ts for a specific administration.

Quick and easy:


npx communibase-types-generator -D @types -k <api-key>

Will generate @types/communibase.d.ts for the given api-key administration.

types are declared in namespace Communibase (i.e. Communibase.Address)

Why

This project makes the following multi-cli solution easier;

  1. Generate the swagger.json from the administration

    npx communibase-swagger <administrationKey> `./@types/swagger.json`
    
  2. Generate the swagger.d.ts from the swagger.json

    npx dtsgenerator --out ./@types/swagger.d.ts ./@types/swagger.json
    
  3. Change the ./@types/swagger.d.ts to export the namespace

    ---declare namespace Definitions {
    +++export namespace Definitions {