API

The remaining types specified in `@parcel/types`

The most important data types are listed on the page of the relevant plugin type.

AST parcel/packages/core/types/index.js:14

Plugin-specific AST, any

Type

type AST = _AST;

Referenced by:

Asset, BaseAsset, BundleResult, MutableAsset, Transformer, TransformerResult

ConfigResult parcel/packages/core/types/index.js:15

Type

type ConfigResult = _ConfigResult;

Referenced by:

BaseAsset, Bundler, Config, ConfigOutput, ConfigResultWithFilePath, MultiThreadValidator, Packager, Transformer

ConfigResultWithFilePath parcel/packages/core/types/index.js:17

Plugin-specific config result, any

type ConfigResultWithFilePath = {|

  contents: ConfigResult,

  filePath: FilePath,

|}

Referenced by:

Config

EnvMap parcel/packages/core/types/index.js:22

process.env

Type

type EnvMap = typeof process.env;

Referenced by:

InitialParcelOptions, PluginOptions

QueryParameters parcel/packages/core/types/index.js:24

type QueryParameters = {

Referenced by:

BaseAsset

JSONValue parcel/packages/core/types/index.js:26

Type

type JSONValue = null | void | boolean | number | string | Array<JSONValue> | JSONObject;

JSONObject parcel/packages/core/types/index.js:36

A JSON object (as in "map")

type JSONObject = {

Referenced by:

JSONValue, Meta

PackageName parcel/packages/core/types/index.js:38

Type

type PackageName = string;

Referenced by:

Config, Environment, EnvironmentOpts, PackageJSON, PackageTargetDescriptor, RawParcelConfig, RawParcelConfigPipeline

FilePath parcel/packages/core/types/index.js:39

Type

type FilePath = string;

Referenced by:

BaseAsset, Bundle, Config, ConfigResultWithFilePath, Diagnostic, File, HTTPSOptions, InitialParcelOptions, MutableAsset, NamedBundle, Namer, PackageJSON, PackageTargetDescriptor, PluginOptions, RawParcelConfig, ResolveConfigFn, ResolveConfigWithPathFn, ResolveFn, ResolveResult, ResolvedParcelConfigFile, Resolver, RuntimeAsset, ServerOptions, Target, TargetDescriptor, TransformerResult, TransformingProgressEvent, ValidationEvent

Glob parcel/packages/core/types/index.js:40

Type

type Glob = string;

Referenced by:

PackageJSON, RawParcelConfig

Semver parcel/packages/core/types/index.js:41

Type

type Semver = string;

Referenced by:

Config, PackageJSON

SemverRange parcel/packages/core/types/index.js:42

Type

type SemverRange = string;

Referenced by:

Engines

ModuleSpecifier parcel/packages/core/types/index.js:44

See Dependency

Type

type ModuleSpecifier = string;

Referenced by:

Dependency, DependencyOptions, InitialParcelOptions

GlobMap parcel/packages/core/types/index.js:47

A pipeline as specified in the config mapping to T

type GlobMap<T> = {

RawParcelConfigPipeline parcel/packages/core/types/index.js:49

Type

type RawParcelConfigPipeline = Array<PackageName>;

Referenced by:

RawParcelConfig

HMROptions parcel/packages/core/types/index.js:51

type HMROptions = {

  port?: number,

  host?: string,

Referenced by:

InitialParcelOptions, PluginOptions

RawParcelConfig parcel/packages/core/types/index.js:54

The format of .parcelrc

type RawParcelConfig = {|

  extends?: PackageName | FilePath | Array<PackageName | FilePath>,

  resolvers?: RawParcelConfigPipeline,

  transformers?: {
    [Glob]: RawParcelConfigPipeline,
    ...
  },

  bundler?: PackageName,

  namers?: RawParcelConfigPipeline,

  runtimes?: {
    [EnvironmentContext]: RawParcelConfigPipeline,
    ...
  },

  packagers?: {
    [Glob]: PackageName,
    ...
  },

  optimizers?: {
    [Glob]: RawParcelConfigPipeline,
    ...
  },

  reporters?: RawParcelConfigPipeline,

  validators?: {
    [Glob]: RawParcelConfigPipeline,
    ...
  },

|}

Referenced by:

ResolvedParcelConfigFile

ResolvedParcelConfigFile parcel/packages/core/types/index.js:68

A .parcelrc where all package names are resolved

type ResolvedParcelConfigFile = {|

  ...RawParcelConfig,

  +filePath: FilePath,

  +resolveFrom?: FilePath,

|}

Engines parcel/packages/core/types/index.js:75

Corresponds to pkg#engines

type Engines = {

  +browsers?: string | Array<string>,

  +electron?: SemverRange,

  +node?: SemverRange,

  +parcel?: SemverRange,

Referenced by:

Environment, EnvironmentOpts, InitialParcelOptions, PackageJSON, PackageTargetDescriptor

TargetSourceMapOptions parcel/packages/core/types/index.js:84

Corresponds to pkg#targets.*.sourceMap

type TargetSourceMapOptions = {|

  +sourceRoot?: string,

  +inline?: boolean,

  +inlineSources?: boolean,

|}

Referenced by:

PackageTargetDescriptor, Target

Target parcel/packages/core/types/index.js:93

A parsed version of PackageTargetDescriptor

interface Target {

  +distEntry: ?FilePath,

The output filename of the entry

  +distDir: FilePath,

The output folder

  +env: Environment,

  +sourceMap: ?TargetSourceMapOptions,

  +name: string,

  +publicUrl: string,

  +loc: ?SourceLocation,

The location that created this Target, e.g. `package.json#main`

Referenced by:

Bundle, BundleGroup, CreateBundleOpts, Dependency, DependencyOptions, MutableBundleGraph, PackageTargetDescriptor

EnvironmentContext parcel/packages/core/types/index.js:107

In which environment the output should run (influces e.g. bundle loaders)

Type

type EnvironmentContext = 'browser' | 'web-worker' | 'service-worker' | 'node' | 'electron-main' | 'electron-renderer';

Referenced by:

BundleGraph, Environment, EnvironmentOpts, PackageTargetDescriptor, RawParcelConfig

OutputFormat parcel/packages/core/types/index.js:116

The JS module format for the bundle output

Type

type OutputFormat = 'esmodule' | 'commonjs' | 'global';

Referenced by:

Environment, EnvironmentOpts, PackageTargetDescriptor

PackageTargetDescriptor parcel/packages/core/types/index.js:123

The format of pkg#targets.*
See Environment and Target.

type PackageTargetDescriptor = {|

  +context?: EnvironmentContext,

  +engines?: Engines,

  +includeNodeModules?: boolean | Array<PackageName> | {
    [PackageName]: boolean,
    ...
  },

  +outputFormat?: OutputFormat,

  +publicUrl?: string,

  +distDir?: FilePath,

  +sourceMap?: boolean | TargetSourceMapOptions,

  +isLibrary?: boolean,

  +minify?: boolean,

  +scopeHoist?: boolean,

|}

Referenced by:

PackageJSON, Target, TargetDescriptor

TargetDescriptor parcel/packages/core/types/index.js:144

The target format when using the JS API.
(Same as PackageTargetDescriptor, but distDir is required.)

type TargetDescriptor = {|

  ...PackageTargetDescriptor,

  +distDir: FilePath,

|}

Referenced by:

InitialParcelOptions

EnvironmentOpts parcel/packages/core/types/index.js:152

This is used when creating an Environment (see that).

type EnvironmentOpts = {|

  +context?: EnvironmentContext,

  +engines?: Engines,

  +includeNodeModules?: boolean | Array<PackageName> | {
    [PackageName]: boolean,
    ...
  },

  +outputFormat?: OutputFormat,

  +isLibrary?: boolean,

  +minify?: boolean,

  +scopeHoist?: boolean,

|}

Referenced by:

DependencyOptions, MutableAsset, TransformerResult

VersionMap parcel/packages/core/types/index.js:177

A resolved browserslist, e.g.:


{
  edge: '76',
  firefox: '67',
  chrome: '63',
  safari: '11.1',
  opera: '50',
}

type VersionMap = {

Referenced by:

Environment

Environment parcel/packages/core/types/index.js:185

Defines the environment in for the output bundle

interface Environment {

  +context: EnvironmentContext,

  +engines: Engines,

  +includeNodeModules: boolean | Array<PackageName> | {
    [PackageName]: boolean,
    ...
  },

Whether to include all/none packages (true / false), an array of package names to include, or an object (of a package is not specified, it's included).

  +outputFormat: OutputFormat,

  +isLibrary: boolean,

Whether this is a library build (e.g. less loaders)

  +minify: boolean,

Whether the output should be minified.

  +scopeHoist: boolean,

Whether scope hoisting is enabled.

  isBrowser(): boolean,

Whether context specifies a browser context.

  isNode(): boolean,

Whether context specifies a node context.

  isElectron(): boolean,

Whether context specifies an electron context.

  isWorker(): boolean,

Whether context specifies a worker context.

  isIsolated(): boolean,

Whether context specifies an isolated context (can't access other loaded ancestor bundles).

  matchesEngines(minVersions: VersionMap): boolean,

Referenced by:

BaseAsset, Bundle, Config, CreateBundleOpts, Dependency, EnvironmentOpts, PackageTargetDescriptor, Target

PackageDependencies parcel/packages/core/types/index.js:220

Format of pkg#dependencies, pkg#devDependencies, pkg#peerDependencies

type PackageDependencies = {|

|}

Referenced by:

PackageJSON

PackageJSON parcel/packages/core/types/index.js:227

Format of package.json

type PackageJSON = {

  name: PackageName,

  version: Semver,

  main?: FilePath,

  module?: FilePath,

  types?: FilePath,

  browser?: FilePath | {
    [FilePath]: FilePath | boolean,
    ...
  },

  source?: FilePath | {
    [FilePath]: FilePath,
    ...
  },

  alias?: {
    [PackageName | FilePath | Glob]: PackageName | FilePath,
    ...
  },

  browserslist?: Array<string>,

  engines?: Engines,

  targets?: {
    [string]: PackageTargetDescriptor,
    ...
  },

  dependencies?: PackageDependencies,

  devDependencies?: PackageDependencies,

  peerDependencies?: PackageDependencies,

  sideEffects?: boolean | FilePath | Array<FilePath>,

Referenced by:

BaseAsset, Config

LogLevel parcel/packages/core/types/index.js:246

Type

type LogLevel = 'none' | 'error' | 'warn' | 'info' | 'verbose';

Referenced by:

InitialParcelOptions, PluginOptions

BuildMode parcel/packages/core/types/index.js:247

Type

type BuildMode = 'development' | 'production' | string;

Referenced by:

InitialParcelOptions, PluginOptions

InitialParcelOptions parcel/packages/core/types/index.js:249

type InitialParcelOptions = {|

  +entries?: FilePath | Array<FilePath>,

  +entryRoot?: FilePath,

  +config?: ModuleSpecifier,

  +defaultConfig?: ModuleSpecifier,

  +env?: EnvMap,

  +targets?: ?(Array<string> | {
    +[string]: TargetDescriptor,
    ...
  }),

  +disableCache?: boolean,

  +cacheDir?: FilePath,

  +killWorkers?: boolean,

  +mode?: BuildMode,

  +minify?: boolean,

  +scopeHoist?: boolean,

  +sourceMaps?: boolean,

  +publicUrl?: string,

  +distDir?: FilePath,

  +hot?: ?HMROptions,

  +contentHash?: boolean,

  +serve?: InitialServerOptions | false,

  +autoinstall?: boolean,

  +logLevel?: LogLevel,

  +profile?: boolean,

  +patchConsole?: boolean,

  +inputFS?: FileSystem,

  +outputFS?: FileSystem,

  +workerFarm?: WorkerFarm,

  +packageManager?: PackageManager,

  +defaultEngines?: Engines,

  +detailedReport?: number | boolean,

|}

InitialServerOptions parcel/packages/core/types/index.js:286

type InitialServerOptions = {|

  +publicUrl?: string,

  +host?: string,

  +port: number,

  +https?: HTTPSOptions | boolean,

|}

Referenced by:

InitialParcelOptions

PluginOptions parcel/packages/core/types/index.js:293

interface PluginOptions {

  +mode: BuildMode,

  +sourceMaps: boolean,

  +env: EnvMap,

  +hot: ?HMROptions,

  +serve: ServerOptions | false,

  +autoinstall: boolean,

  +logLevel: LogLevel,

  +entryRoot: FilePath,

  +projectRoot: FilePath,

  +cacheDir: FilePath,

  +inputFS: FileSystem,

  +outputFS: FileSystem,

  +packageManager: PackageManager,

  +instanceId: string,

  +detailedReport: number,

Referenced by:

Bundler, DedicatedThreadValidator, MultiThreadValidator, Namer, Optimizer, Packager, Reporter, Resolver, Runtime, Transformer

ServerOptions parcel/packages/core/types/index.js:311

type ServerOptions = {|

  +distDir: FilePath,

  +host?: string,

  +port: number,

  +https?: HTTPSOptions | boolean,

  +publicUrl?: string,

|}

Referenced by:

PluginOptions

HTTPSOptions parcel/packages/core/types/index.js:319

type HTTPSOptions = {|

  +cert: FilePath,

  +key: FilePath,

|}

Referenced by:

InitialServerOptions, ServerOptions

SourceLocation parcel/packages/core/types/index.js:327

Source locations are 1-based, meaning lines and columns start at 1

type SourceLocation = {|

  +filePath: string,

  +start: {|
    +line: number,
    +column: number,
  |},

inclusive

  +end: {|
    +line: number,
    +column: number,
  |},

exclusive

|}

Referenced by:

Dependency, DependencyOptions, MutableSymbols, SymbolResolution, Symbols, Target, TransformerResult

Meta parcel/packages/core/types/index.js:344

An object that plugins can write arbitatry data to.

Type

type Meta = JSONObject;

Referenced by:

BaseAsset, Dependency, DependencyOptions, TransformerResult

Symbol parcel/packages/core/types/index.js:349

An identifier in an asset (likely imported/exported).

Type

type Symbol = string;

Referenced by:

BundleGraph, DependencyOptions, ExportSymbolResolution, MutableSymbols, SymbolResolution, Symbols, TransformerResult

Symbols parcel/packages/core/types/index.js:350

interface Symbols extends Iterable<[Symbol, {|
  local: Symbol,
  loc: ?SourceLocation,
|}]> {

  get(exportSymbol: Symbol): ?{|
    local: Symbol,
    loc: ?SourceLocation,
  |},

  hasExportSymbol(exportSymbol: Symbol): boolean,

  hasLocalSymbol(local: Symbol): boolean,

  +isCleared: boolean,

Referenced by:

BaseAsset, MutableSymbols

MutableSymbols parcel/packages/core/types/index.js:358

interface MutableSymbols extends Symbols {

  clear(): void,

  set(exportSymbol: Symbol, local: Symbol, loc: ?SourceLocation): void,

Referenced by:

Dependency, MutableAsset

File parcel/packages/core/types/index.js:421

type File = {|

  +filePath: FilePath,

  +hash?: string,

|}

Referenced by:

ConfigOutput, TransformerResult

Stats parcel/packages/core/types/index.js:574

type Stats = {|

  time: number,

  size: number,

|}

Referenced by:

Asset, Bundle

Blob parcel/packages/core/types/index.js:587

Type

type Blob = string | Buffer | Readable;

Referenced by:

BundleResult, GenerateOutput, Optimizer, Packager, TransformerResult

Async parcel/packages/core/types/index.js:614

Type

type Async<T> = T | Promise<T>;

Referenced by:

Bundler, DedicatedThreadValidator, MultiThreadValidator, Namer, Optimizer, Packager, Reporter, Resolver, Runtime, Transformer

ConfigOutput parcel/packages/core/types/index.js:1024

type ConfigOutput = {|

  config: ConfigResult,

  files: Array<File>,

|}

Referenced by:

Bundler, Packager

ErrorWithCode parcel/packages/core/types/index.js:1315

interface ErrorWithCode extends Error {

  +code?: string,

IDisposable parcel/packages/core/types/index.js:1319

interface IDisposable {

  dispose(): mixed,

AsyncSubscription parcel/packages/core/types/index.js:1323

interface AsyncSubscription {

  unsubscribe(): Promise<mixed>,