# magento2-graphql-types

> TypeScript definitions for the Magento 2 Graphql API

Latest version **4.1.1** (published 2021-02-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install magento2-graphql-types
pnpm add magento2-graphql-types
yarn add magento2-graphql-types
bun add magento2-graphql-types
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.1.1 |
| Published | 2021-02-06 |
| First published | 2021-02-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 268.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Andrew Jones |
| Maintainers | aej11a |
| Keywords | magento, magento2, typescript, magento 2 typescript, magento 2 types |

## Links

- npm: https://www.npmjs.com/package/magento2-graphql-types
- Homepage: https://github.com/aej11a/magento2-graphql-types
- Issues: https://github.com/aej11a/magento2-graphql-types/issues
- npm.io page: https://npm.io/package/magento2-graphql-types

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 4.1.1 (latest) — 2021-02-06
- 4.1.0 — 2021-02-06

## README

# magento2-graphql-types

This repository exports TypeScript types for the current Magento 2 version GraphQL API.

You can treat the types as helpers for when you work with M2 GraphQL.

## Versioning

Since this repo and project is dedicated to Magento 2, the _first_ two digits in this package's semver will always match the _last_ two digits of the current Magento version. For example, for Magento 2.4.1, this package will have version number 4.1.x. The last number will start at 0, then be used for patches or bugfixes.

Another example: For Magento 2.6.5, this package will use the version numbers 6.5.0, 6.5.1, 6.5.2, etc.

## Example

```js
import { CmsPage } from 'magento2-graphql-types'

const getData = async () => {
    const res = await fetch('https://venia.magento.com/graphql?query=query+getCmsPage%28%24id%3AInt%21%29%7BcmsPage%28id%3A%24id%29%7Burl_key+content+content_heading+title+page_layout+meta_title+meta_keywords+meta_description+__typename%7D%7D&operationName=getCmsPage&variables=%7B%22id%22%3A7%7D')
    const resJson = await res.json()
    
    const data = resJson.data.cmsPage as CmsPage

    if(data.__typename === "Test"){ 
        //ts2367: This condition will always return 'false' since the types '"CmsPage" | undefined' and '"Test"' have no overlap.
        console.log("This never runs!")
    }
}

getData()
```

## Contributing

Please note that all contributions fall under the MIT license which this project uses.

This project is not officially affiliated with Adobe or Magento.

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