https://github.com/flex-development/pkg-types
TypeScript definitions for package.json
https://github.com/flex-development/pkg-types
package-json typescript typescript-definitions
Last synced: 2 months ago
JSON representation
TypeScript definitions for package.json
- Host: GitHub
- URL: https://github.com/flex-development/pkg-types
- Owner: flex-development
- License: bsd-3-clause
- Created: 2022-11-30T04:29:31.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-23T03:44:19.000Z (about 1 year ago)
- Last Synced: 2024-05-01T09:40:38.601Z (about 1 year ago)
- Topics: package-json, typescript, typescript-definitions
- Language: TypeScript
- Homepage: https://github.com/flex-development/pkg-types
- Size: 3.26 MB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/funding.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# pkg-types
[](https://github.com/flex-development/pkg-types/releases/latest)
[](https://npmjs.com/package/@flex-development/pkg-types)
[](https://github.com/voxpelli/badges-cjs-esm)
[](LICENSE.md)
[](https://conventionalcommits.org)
[](https://typescriptlang.org)
[](https://vitest.dev)
[](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
```
See Git - Protocols | Yarn
for details regarding installing from Git.
## 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