npm package: @flex-development/pkg-types
Description: TypeScript definitions for package.json
Author: Lexus Drumgold
Latest version: 4.1.0

# pkg-types

[![github release](https://img.shields.io/github/v/release/flex-development/pkg-types.svg?include_prereleases\&sort=semver)](https://github.com/flex-development/pkg-types/releases/latest)
[![npm](https://img.shields.io/npm/v/@flex-development/pkg-types.svg)](https://npmjs.com/package/@flex-development/pkg-types)
[![module type: esm](https://img.shields.io/badge/module%20type-esm-brightgreen)](https://github.com/voxpelli/badges-cjs-esm)
[![license](https://img.shields.io/github/license/flex-development/pkg-types.svg)](LICENSE.md)
[![conventional commits](https://img.shields.io/badge/-conventional%20commits-fe5196?logo=conventional-commits\&logoColor=ffffff)](https://conventionalcommits.org)
[![typescript](https://img.shields.io/badge/-typescript-3178c6?logo=typescript\&logoColor=ffffff)](https://typescriptlang.org)
[![vitest](https://img.shields.io/badge/-vitest-6e9f18?style=flat\&logo=vitest\&logoColor=ffffff)](https://vitest.dev)
[![yarn](https://img.shields.io/badge/-yarn-2c8ebb?style=flat\&logo=yarn\&logoColor=ffffff)](https://yarnpkg.com)

[TypeScript][] definitions for `package.json`

## Contents

- [What is this?](#what-is-this)
- [Install](#install)
- [Use](#use)
- [API](#api)
- [Related](#related)
- [Contribute](#contribute)

## What is this?

This package contains TypeScript definitions for `package.json` files and values used in `package.json` files.

## Install

In Node.js with [yarn][]:

```sh
yarn add @flex-development/pkg-types
```

<blockquote>
  <small>
    See <a href='https://yarnpkg.com/protocol/git'>Git - Protocols | Yarn</a>
    &nbsp;for details regarding installing from Git.
  </small>
</blockquote>

## Use

```ts
import type {
  Condition,
  ConditionMap,
  ConditionalTargets,
  Exports,
  ExportsKey,
  ExportsObject,
  ExportsSubpath,
  Imports,
  ImportsSubpath,
  PackageJson,
  PackageType,
  SubpathExports,
  Target,
  TargetList
} from '@flex-development/pkg-types'
```

## API

- [`Access`](./src/access.ts)
- [`BinObject`](./src/bin-object.ts)
- [`Bin`](./src/bin.ts)
- [`BrowserObject`](./src/browser-object.ts)
- [`Browser`](./src/browser.ts)
- [`Bugs`](./src/bugs.ts)
- [`CPUMap`](./src/cpu-map.ts)
- [`CPU`](./src/cpu.ts)
- [`ConditionMap`](./src/condition-map.ts)
- [`Condition`](./src/condition.ts)
- [`ConditionalTargets`](./src/conditional-targets.ts)
- [`Config`](./src/config.ts)
- [`Dependencies`](./src/dependencies.ts)
- [`DevDependencies`](./src/dev-dependencies.ts)
- [`Directories`](./src/directories.ts)
- [`EngineMap`](./src/engine-map.ts)
- [`Engine`](./src/engine.ts)
- [`Engines`](./src/engines.ts)
- [`ExportsKey`](./src/exports-key.ts)
- [`ExportsObject`](./src/exports-object.ts)
- [`ExportsSubpath`](./src/exports-subpath.ts)
- [`Exports`](./src/exports.ts)
- [`ImportsSubpath`](./src/imports-subpath.ts)
- [`Imports`](./src/imports.ts)
- [`JsonArray`](./src/json-array.ts)
- [`JsonObject`](./src/json-object.ts)
- [`JsonPrimitive`](./src/json-primitive.ts)
- [`JsonValue`](./src/json-value.ts)
- [`LicenseInfo`](./src/license-info.ts)
- [`OSMap`](./src/os-map.ts)
- [`OS`](./src/os.ts)
- [`OptionalDependencies`](./src/optional-dependencies.ts)
- [`PackageJson`](./src/package-json.ts)
- [`PackageManagerMap`](./src/package-manager-map.ts)
- [`PackageManager`](./src/package-manager.ts)
- [`PackageType`](./src/package-type.ts)
- [`PeerDependenciesMeta`](./src/peer-dependencies-meta.ts)
- [`PeerDependencies`](./src/peer-dependencies.ts)
- [`PeerDependencyMetadata`](./src/peer-dependency-metadata.ts)
- [`People`](./src/people.ts)
- [`Person`](./src/person.ts)
- [`PublishConfig`](./src/publish-config.ts)
- [`RepositoryInfo`](./src/repository-info.ts)
- [`RepositoryTypeMap`](./src/repository-type-map.ts)
- [`RepositoryType`](./src/repository-type.ts)
- [`Scripts`](./src/scripts.ts)
- [`SemanticVersion`](./src/semantic-version.ts)
- [`SubpathExports`](./src/subpath-exports.ts)
- [`TargetList`](./src/target-list.ts)
- [`Target`](./src/target.ts)
- [`TypesVersions`](./src/types-versions.ts)
- [`WorkspacesConfig`](./src/workspaces-config.ts)

## Related

- [`tsconfig-types`][tsconfig-types] — TypeScript definitions for `tsconfig.json`

## Contribute

See [`CONTRIBUTING.md`](CONTRIBUTING.md).

This project has a [code of conduct](./CODE_OF_CONDUCT.md). By interacting with this repository, organization, or
community you agree to abide by its terms.

[tsconfig-types]: https://github.com/flex-development/tsconfig-types

[typescript]: https://www.typescriptlang.org

[yarn]: https://yarnpkg.com