Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@salesforce/kit

forcedotcom3.5mBSD-3-Clause3.2.3TypeScript support: included

Commonly needed utilities for TypeScript and JavaScript

readme

Utilities for Salesforce CLI development

What is this?

A collection of commonly needed utilities used by the Salesforce CLI and the libraries it is built on. It includes high level support for parsing and working with JSON data, interacting with environment variables, a common error base type, a minimal lodash replacement, and support for commonly needed design patterns, among other things. It is intended specifically for use in Node.js (version 8 or newer) projects -- YMMV in the browser.

see the API documentation for more details on each of the utilities that kit provides.

References

This library depends upon another Salesforce TypeScript library, @salesforce/ts-types. The API documentation for this library refers to several types that you will find in ts-types. Some lodash replacement functions are also found in ts-types.

changelog

3.2.3 (2024-09-12)

Bug Fixes

  • deps: bump path-to-regexp from 1.8.0 to 1.9.0 (13d1bc3)

3.2.2 (2024-08-31)

Bug Fixes

  • deps: bump micromatch from 4.0.4 to 4.0.8 (8c7443b)

3.2.1 (2024-08-04)

Bug Fixes

  • deps: bump @salesforce/ts-types from 2.0.11 to 2.0.12 (b587347)

3.2.0 (2024-07-30)

Features

3.1.6 (2024-06-18)

Bug Fixes

  • private method => function (996e59f)

3.1.5 (2024-06-16)

Bug Fixes

  • deps: bump @salesforce/ts-types from 2.0.9 to 2.0.10 (3c75a88)

3.1.4 (2024-06-13)

Bug Fixes

  • deps: bump braces from 3.0.2 to 3.0.3 (714d646)

3.1.3 (2024-06-09)

Bug Fixes

  • deps: bump tslib from 2.6.2 to 2.6.3 (ac379c0)

3.1.2 (2024-05-24)

Bug Fixes

3.1.1 (2024-04-15)

Bug Fixes

  • regenerate lodash.js for prototype vuln (#312) (1827036)

3.1.0 (2024-03-26)

Features

3.0.15 (2023-10-22)

Bug Fixes

  • deps: bump @salesforce/ts-types from 2.0.8 to 2.0.9 (8ac9c05)

3.0.14 (2023-10-17)

Bug Fixes

  • deps: bump @babel/traverse from 7.15.0 to 7.23.2 (ebc4ee6)

3.0.13 (2023-10-01)

Bug Fixes

  • deps: bump @salesforce/ts-types from 2.0.7 to 2.0.8 (8498231)

3.0.12 (2023-09-28)

Bug Fixes

  • deps: bump get-func-name from 2.0.0 to 2.0.2 (00a3da2)

3.0.11 (2023-08-20)

Bug Fixes

  • deps: bump @salesforce/ts-types from 2.0.6 to 2.0.7 (11a48d4)

3.0.10 (2023-08-20)

Bug Fixes

  • deps: bump tslib from 2.6.1 to 2.6.2 (a598215)

3.0.9 (2023-08-06)

Bug Fixes

  • deps: bump @salesforce/ts-types from 2.0.5 to 2.0.6 (bf318b0)

3.0.8 (2023-08-03)

Bug Fixes

  • throttle promise all infinite loop (06a1d05)

3.0.7 (2023-07-30)

Bug Fixes

  • deps: bump tslib from 2.6.0 to 2.6.1 (9a1a0b1)

3.0.6 (2023-07-17)

Bug Fixes

  • deps: bump @salesforce/ts-types from 2.0.4 to 2.0.5 (dd1e600)

3.0.5 (2023-07-09)

Bug Fixes

  • deps: bump @salesforce/ts-types from 2.0.3 to 2.0.4 (e3e53b7)

3.0.4 (2023-07-05)

Bug Fixes

  • make promise throttle level consistent (#240) (8778166)

3.0.3 (2023-06-04)

Bug Fixes

  • deps: bump @salesforce/ts-types from 2.0.2 to 2.0.3 (18902d8)

3.0.2 (2023-05-28)

Bug Fixes

  • deps: bump @salesforce/ts-types from 2.0.1 to 2.0.2 (b846387)

3.0.1 (2023-05-21)

Bug Fixes

  • deps: bump tslib from 2.5.0 to 2.5.2 (dea4350)

3.0.0 (2023-05-03)

Features

BREAKING CHANGES

  • no intended functionality change, but major versioned to avoid breaking consumers still on node14

  • chore: bump jsdoc plugin

  • chore: bump ts-types, remove shx dep

1.9.2 (2023-03-06)

Bug Fixes

  • ensuer support types are exported (eb564ca)

1.9.1 (2023-03-06)

1.9.0 (2023-02-20)

Features

  • add settleAll with types (6401632)

1.8.5 (2023-02-05)

Bug Fixes

  • deps: bump @salesforce/ts-types from 1.7.2 to 1.7.3 (d13deff)

1.8.4 (2023-01-29)

Bug Fixes

  • deps: bump tslib from 2.4.1 to 2.5.0 (adbf371)

1.8.3 (2023-01-15)

Bug Fixes

  • deps: bump @salesforce/ts-types from 1.7.1 to 1.7.2 (679e76f)

1.8.2 (2023-01-04)

Bug Fixes

  • deps: bump json5 from 1.0.1 to 1.0.2 (f2ffba8)

1.8.1 (2023-01-03)

Bug Fixes

  • getNumber, if given a default, guarantees the return type is of type number (#130) (14a9cf7)

1.8.0 (2022-11-07)

Features

  • add throttled promise class (c020142)

1.7.2 (2022-11-06)

Bug Fixes

  • deps: bump @salesforce/ts-types from 1.7.0 to 1.7.1 (8e76681)

1.7.1 (2022-10-23)

Bug Fixes

  • deps: bump @salesforce/ts-types from 1.5.21 to 1.7.0 (c61a483)

1.7.0 (2022-10-05)

Features

  • create on asyncOptionalCreatable requires that P extend object (e294798)

1.6.1 (2022-09-18)

Bug Fixes

  • deps: bump @salesforce/ts-types from 1.5.20 to 1.5.21 (b8acc98)

1.6.0 (2022-08-15)

Features

1.5.45 (2022-08-02)

1.5.44 (2022-07-02)

1.5.43 (2022-07-02)

1.5.42 (2022-06-02)

1.5.41 (2022-05-02)

1.5.40 (2022-05-02)

1.5.39 (2022-05-02)

1.5.38 (2022-04-02)

1.5.37 (2022-04-02)

1.5.36 (2022-03-31)

1.5.35 (2022-03-31)

1.5.34 (2022-03-02)

1.5.33 (2022-02-12)

1.5.32 (2022-02-02)

1.5.31 (2022-02-02)

1.5.30 (2022-01-15)

1.5.29 (2022-01-15)

1.5.28 (2022-01-12)

Bug Fixes

1.5.26 (2022-01-07)

1.5.25 (2022-01-02)

1.5.24 (2022-01-02)

1.5.23 (2022-01-02)

1.5.22 (2021-12-03)

1.5.21 (2021-12-03)

1.5.20 (2021-12-02)

1.5.19 (2021-12-02)

1.5.18 (2021-11-11)

Features