https://github.com/eeue56/amddiffyn

Automatically get a typescript definition for a json blob from a url, a file, or stdin
https://github.com/eeue56/amddiffyn

Last synced: about 1 month ago
JSON representation

Automatically get a typescript definition for a json blob from a url, a file, or stdin

• Host: GitHub
• URL: https://github.com/eeue56/amddiffyn
• Owner: eeue56
• License: bsd-3-clause
• Created: 2021-05-30T18:14:46.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-07-13T16:23:02.000Z (over 3 years ago)
• Last Synced: 2024-11-10T02:49:57.580Z (2 months ago)
• Language: TypeScript
• Size: 274 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# amddiffyn

Automatically get a typescript definition for a json blob from a url or a file. A good place to start from when dealing with untyped APIs.

Part of the [Hiraeth](https://github.com/eeue56/hiraeth) collection.

## Installation

```

npm install --save @eeue56/amddiffyn

```

## Usage

With a file:

```

npx @eeue56/amddiffyn examples/user.json

```

With a url:

```

npx @eeue56/amddiffyn https://example.com/user.json

```

You can also use it to generate types for [adeilad](https://github.com/eeue56/adeilad) via the `--adeilad` flag:

```

npx @eeue56/amddiffyn --adeilad https://example.com/user.json

```

```

  --adeilad :		If present, generate an adeilad definition

  --stdin :	        Read input from stdin

  -h, --help :		This help text

Provide either a url starting with http/https, or a file path

```

## Name

Amddiffyn means defend. An English speaker may pronounce it as "am-ffith-in".