# graphql-default-value-transformer

> A GraphQL transform that enables default values for a scalar or enum type.

Latest version **2.0.1** (published 2020-04-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install graphql-default-value-transformer
pnpm add graphql-default-value-transformer
yarn add graphql-default-value-transformer
bun add graphql-default-value-transformer
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2020-04-22 |
| First published | 2018-09-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 30.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 16 |
| Author | Rob Ribeiro |
| Maintainers | trek10-package-manager |
| Keywords | graphql, appsync, aws |

## Links

- npm: https://www.npmjs.com/package/graphql-default-value-transformer
- Repository: https://github.com/trek10inc/graphql-default-value-transformer
- Homepage: https://github.com/trek10inc/graphql-default-value-transformer#readme
- Issues: https://github.com/trek10inc/graphql-default-value-transformer/issues
- npm.io page: https://npm.io/package/graphql-default-value-transformer

## Dependencies (4)

- [graphql](https://npm.io/package/graphql.md) ^14.5.8
- [graphql-mapping-template](https://npm.io/package/graphql-mapping-template.md) ^4.13.3
- [graphql-transformer-core](https://npm.io/package/graphql-transformer-core.md) ^6.16.1
- [graphql-transformer-common](https://npm.io/package/graphql-transformer-common.md) ^4.14.0

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 2.0.1 (latest) — 2020-04-22
- 2.0.0 — 2020-04-22
- 1.0.0 — 2018-09-17

## README

# graphql-default-value-transformer

Add default values to fields in GraphQL schemas for AWS Amplify. Confirmed working with Amplify CLI 4.17.2.

## installation

Amplify CLI requires custom transformers to be installed globally as of right now:

```
npm i -g graphql-default-value-transformer
```

## configuration

In your Amplify project, find the `transform.conf.json` file under `<project-path>/amplify/backend/api/<your-api-name>/`. Add the npm package name for this transformer - `graphql-default-value-transformer` - to the `transformers` property:

```
{
  "transformers": [
    "graphql-default-value-transformer"
  ]
}
```

## usage

Supply the `@default` directive with a single `value` parameter on any scalar/enum field under a `@model`. The `value` parameter must be formatted as a string regardless of the corresponding field type.

```
type Post @model {
  id: ID!
  title: String! @default(value: "hello world")
  viewCount: Int @default(value: "9001")
  tag: Tag @default(value: "RANDOM")
}
enum Tag {
  NEWS
  RANDOM
}
```

## limitations

This transformer only supports scalar and enum types, include the AWS specific types (e.g.: `AWSDateTime`).

## license

MIT

---
_Source: https://npm.io/package/graphql-default-value-transformer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._