Options
All
  • Public
  • Public/Protected
  • All
Menu

Package plugin-typescript

@yarnpkg/plugin-typescript

This plugin automatically adds @types/ packages into your dependencies when you add a package that doesn't include its own types.

Install

yarn plugin import typescript

Example

❯ yarn/packages/plugin-typescript ❯ yarn add lodash

➤ BR0000: ┌ Resolution step ➤ BR0002: │ babel-preset-jest@npm:24.1.0 doesn't provide @babel/core@^7.0.0-0 requested by @babel/plugin-syntax-object-rest-spread@npm:7.2.0 ➤ BR0000: └ Completed in 0.24s ➤ BR0000: ┌ Fetch step ➤ BR0013: │ @types/lodash@npm:4.14.121 can't be found in the cache and will be fetched from the remote registry ➤ BR0000: └ Completed in 3.63s ➤ BR0000: ┌ Link step ➤ BR0005: │ webpack-cli@npm:3.2.1 lists build scripts, but its build has been explicitly disabled through configuration. ➤ BR0005: │ fsevents@npm:1.2.6 lists build scripts, but its build has been explicitly disabled through configuration. ➤ BR0005: │ webpack-cli@npm:3.2.1 lists build scripts, but its build has been explicitly disabled through configuration. ➤ BR0005: │ webpack-cli@npm:3.2.1 lists build scripts, but its build has been explicitly disabled through configuration. ➤ BR0000: └ Completed in 2.75s ➤ BR0000: 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): 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

hooks

hooks: object

afterWorkspaceDependencyAddition

afterWorkspaceDependencyAddition: afterWorkspaceDependencyAddition

afterWorkspaceDependencyRemoval

afterWorkspaceDependencyRemoval: afterWorkspaceDependencyRemoval

beforeWorkspacePacking

beforeWorkspacePacking: beforeWorkspacePacking

Generated using TypeDoc