Options
All
  • Public
  • Public/Protected
  • All
Menu

Package plugin-typescript

@yarnpkg/plugin-typescript

Features

  • Automatically adds @types/ packages into your dependencies when you add a package that doesn't include its own types
  • Adds support for types to publishConfig (same behavior as publishConfig.bin)

Install

This plugin is included by default starting from Yarn 4.

Example

 yarn/packages/plugin-typescript  yarn add lodash

YN0000: Resolution step YN0000: Completed in 0.24s YN0000: Fetch step YN0013: @types/lodash@npm:4.14.121 can't be found in the cache and will be fetched from the remote registry YN0013: lodash@npm:4.14.0 can't be found in the cache and will be fetched from the remote registry YN0000: Completed in 3.63s YN0000: Link step YN0000: Completed in 2.75s YN0000: Done with warnings in 6.81s

As you can see in the fetch step, even though we only added lodash into our dependencies, Yarn automatically figured out that we would need @types/lodash, and added it before we ask it to.

Variables

Const ALGOLIA_API_KEY

ALGOLIA_API_KEY: "e8e1bd300d860104bb8c58453ffa1eb4" = `e8e1bd300d860104bb8c58453ffa1eb4`

Const ALGOLIA_APP_ID

ALGOLIA_APP_ID: "OFCNCOG2CU" = `OFCNCOG2CU`

Functions

Const afterWorkspaceDependencyAddition

  • afterWorkspaceDependencyAddition(workspace: Workspace, dependencyTarget: Target, descriptor: Descriptor, strategies: Array<Strategy>): Promise<void>

Const afterWorkspaceDependencyRemoval

  • afterWorkspaceDependencyRemoval(workspace: Workspace, dependencyTarget: Target, descriptor: Descriptor): Promise<void>

Const beforeWorkspacePacking

  • beforeWorkspacePacking(workspace: Workspace, rawManifest: any): void

Const createAlgoliaClient

  • createAlgoliaClient(configuration: Configuration): object & object & object

Const getTypesName

Const hasDefinitelyTyped

Object literals

Const plugin

plugin: object

configuration

configuration: object

tsEnableAutoTypes

tsEnableAutoTypes: object

default

default: null = null

description

description: string = `Whether Yarn should auto-install @types/ dependencies on 'yarn add'`

isNullable

isNullable: true = true

type

type: BOOLEAN = SettingsType.BOOLEAN

hooks

hooks: object

afterWorkspaceDependencyAddition

afterWorkspaceDependencyAddition: afterWorkspaceDependencyAddition

afterWorkspaceDependencyRemoval

afterWorkspaceDependencyRemoval: afterWorkspaceDependencyRemoval

beforeWorkspacePacking

beforeWorkspacePacking: beforeWorkspacePacking

Generated using TypeDoc