xref: /expo/packages/@expo/config-types/README.md (revision dfd15ebd)
1<!-- Title -->
2<h1 align="center">
3�� Welcome to <br><code>@expo/config-types</code>
4</h1>
5
6<p align="center">Types for the Expo config object <code>app.config.ts</code>.</p>
7
8<p align="center">
9  <img src="https://flat.badgen.net/packagephobia/install/@expo/config-types">
10
11  <a href="https://www.npmjs.com/package/@expo/config-types">
12    <img src="https://flat.badgen.net/npm/dw/@expo/config-types" target="_blank" />
13  </a>
14</p>
15
16<!-- Body -->
17
18## Usage
19
20```ts
21import { ExpoConfig } from '@expo/config-types';
22
23export default (): ExpoConfig => {
24  return {
25    name: 'My App',
26    slug: 'my-app',
27  };
28};
29```
30
31## Contributing
32
33This package is 100% generated using the versioned JSON schemas from the Expo server.
34
35- `yarn generate` - uses the major version from the `package.json`.
36- `yarn generate --path ../../../universe/server/www/xdl-schemas/UNVERSIONED-schema.json` - uses the latest version from your local directory.
37- `yarn generate 39` - uses the given version.
38- `yarn generate unversioned` - uses the latest version.
39