README.md

pkg-types

TypeScript definitions for package.json

Contents

• What is this?
• Install
• Use
• API
• Related
• 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:

yarn add @flex-development/pkg-types

See Git - Protocols | Yarn  for details regarding installing from Git.

Use

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

API

• Access
• BinObject
• Bin
• BrowserObject
• Browser
• Bugs
• CPUMap
• CPU
• ConditionMap
• Condition
• ConditionalTargets
• Config
• Dependencies
• DevDependencies
• Directories
• EngineMap
• Engine
• Engines
• ExportsKey
• ExportsObject
• ExportsSubpath
• Exports
• ImportsSubpath
• Imports
• JsonArray
• JsonObject
• JsonPrimitive
• JsonValue
• LicenseInfo
• OSMap
• OS
• OptionalDependencies
• PackageJson
• PackageManagerMap
• PackageManager
• PackageType
• PeerDependenciesMeta
• PeerDependencies
• PeerDependencyMetadata
• People
• Person
• PublishConfig
• RepositoryInfo
• RepositoryTypeMap
• RepositoryType
• Scripts
• SemanticVersion
• SubpathExports
• TargetList
• Target
• TypesVersions
• WorkspacesConfig

Related

• tsconfig-types — TypeScript definitions for tsconfig.json

Contribute

See CONTRIBUTING.md.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.