JvM Contentful typings generator

Generate typescript definitions based on your Contentful content models. It's mainly a wrapper around cf-content-types-generator

Getting started

Install

npm install --save-dev @jungvonmatt/contentful-typings

Commands

help

npx contentful-typings help [command]

generate

Fetch all content entries and store them as yaml in the configured directory

npx contentful-typings generate [options]

options

  -o, --output <filepath>         Specify output file (default: "@types/contentful.d.ts")
  -l, --localized                 Add localized types
  -d, --jsdoc                     Add JSDoc comments
  -g, --typeguard                 Add type guards
  --config <configuration file>   Use this configuration, overriding other config options if present
  --cwd <directory>               Working directory. Defaults to process.cwd()
  -h, --help                      display help for command