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

Package detail

fastify-disablecache

Fdawgs19.3kMIT4.0.1TypeScript support: included

Fastify plugin to disable client-side caching

cache, disable, disablecache, expires, fastify, headers, nocache, plugin, pragma, surrogate

readme

fastify-disablecache

GitHub Release npm version CI Coverage status code style: Prettier

Fastify plugin to disable client-side caching

Overview

Inspired by nocache, the fastify-disablecache plugin sets the following response headers and values to disable client-side caching:

Cache-Control: no-store, max-age=0, must-revalidate
Expires: 0
Pragma: no-cache
Surrogate-Control: no-store

This plugin was created out of a need for an easy way to disable client-side caching for data received from backend APIs. This ensures data is always current when called by applications.

Why these headers?

Installation

Install using npm:

npm i fastify-disablecache

For Fastify v4.x support, use `fastify-disablecache@3.1.9`.

Example usage

const Fastify = require("fastify");
const disableCache = require("fastify-disablecache");

const server = Fastify();
server.register(disableCache);

server.get("/", (_req, res) => {
    res.send("ok");
});

server.listen(3000, (err) => {
    if (err) throw err;
    console.log("Server listening on 3000");
});

Contributing

Contributions are welcome, and any help is greatly appreciated!

See the contributing guide for details on how to get started. Please adhere to this project's Code of Conduct when contributing.

Acknowledgements

License

fastify-disablecache is licensed under the MIT license.

changelog

Changelog

All notable changes to this project will be documented in this file.

4.0.1 (2025-01-13)

Continuous integration

  • cd: migrate to manifest config (63c39df)
  • ci: use major tag for coverallsapp/github-action (8b7afda)
  • deps: bump coverallsapp/github-action from 2.3.0 to 2.3.1 (#290) (dec22db)
  • deps: bump coverallsapp/github-action from 2.3.1 to 2.3.4 (#293) (284c5f2)
  • release-please: declare schema (c524887)

Dependencies

  • deps-dev: bump dev dependencies (ed7b649)
  • migrate from jest to native node:test (3c8c12e)

Documentation

  • readme: rename ci badge to reflect workflow (50bd691)

Miscellaneous

  • jsconfig: set schema (ce4e0fc)
  • license: update license year (76ddfbc)

4.0.0 (2024-10-02)

⚠ BREAKING CHANGES

  • dropped support for fastify v4.x
  • dropped support for node 14, 16 and 18

Continuous integration

  • cd: sort release note sections alphabetically (76b4cb1)
  • cd: standardise @fdawgs cd workflows (7805d50)
  • ci: audit package signatures and provenance attestations (9834618)
  • ci: standardise @fdawgs ci workflows (9338478)
  • dependabot: add [@eslint-community](https://github.com/eslint-community) scoped deps to eslint group (25bc7a3)
  • deps: bump actions/dependency-review-action from 3 to 4 (#265) (1617313)
  • deps: bump coverallsapp/github-action from 2.2.3 to 2.3.0 (#280) (bbc2391)
  • deps: bump wagoid/commitlint-github-action from 5 to 6 (#271) (ded4173)
  • use latest node lts version (b66b26f)

Dependencies

  • deps-dev: bump dev dependencies (#269) (6be0699)
  • deps-dev: bump husky from 8.0.3 to 9.0.6 (#266) (0b723dc)
  • deps-dev: bump the commitlint group with 2 updates (#270) (9957b68)

Features

Miscellaneous

  • .husky/commit-msg: remove npx usage (20eb2ff)
  • .husky: migrate hooks to v9 style (2b43de1)
  • .npmrc: enforce strict engine checks (a5b1a57)
  • .vscode: fix prettier.prettierPath setting (9514d9d)
  • drop support for node 14, 16, and 18 (86ac353)
  • index: inline comment re export types (7b33ad1)
  • jsconfig: enable strict type checking (0261ede)
  • package: change author email (ce9029f)

3.1.9 (2024-01-25)

Dependencies

  • deps-dev: bump dev dependencies (e136202)

Miscellaneous

  • .vscode: use local prettier version (32977ab)
  • jsconfig: remove lib; target will be used in absence (c7271cd)
  • package: fix repository structure (d9c248f)
  • scripts/license-checker: handle old license arrays or missing (1ba9d6a)

Continuous integration

  • automerge: optimise inline js scripts (12e618f)
  • cd: publish to github packages with provenance (bf45214)
  • cd: use main environment for publish-npm job (ef73844)

3.1.8 (2024-01-09)

Dependencies

  • deps-dev: bump dev dependencies (40d544c)

Miscellaneous

  • jsdoc comments must be complete sentences (a663853)
  • license: update license year (4414368)
  • package: add lint:fix script (18c6e66)
  • package: run lint:prettier in test script (c267b3c)
  • use shared files from fdawgs/.github (19727b5)

Continuous integration

  • cd: add github packages publish job (aedfd9a)
  • dependabot: ignore release-please-action major updates (0963ae5)
  • deps: bump actions/upload-artifact from 3 to 4 (#257) (f4cafd3)
  • deps: bump github/codeql-action from 2 to 3 (#256) (063a2c0)

Documentation

3.1.7 (2023-11-29)

Dependencies

  • deps-dev: add eslint-community/eslint-plugin-eslint-comments (e787a9f)
  • deps-dev: bump dev dependencies (ceb5228)
  • deps-dev: bump the commitlint group with 2 updates (#249) (dfdbbab)
  • deps-dev: bump the eslint group with 1 update (#250) (e80a458)
  • deps-dev: remove broken eslint-plugin-security-node (a4996ca)

Miscellaneous

  • .vscode: add github-markdown-preview to recommended extension (deaeec8)
  • .vscode: add gitlens to recommended extensions (f3f207b)
  • jsconfig: use es2022 lib (b1bb1c1)
  • scripts/license-checker: update link to deprecated list (76ea680)

Continuous integration

  • deps: bump actions/github-script from 6 to 7 (#251) (5099a42)
  • deps: bump actions/setup-node from 3 to 4 (#248) (f57d3ea)

Documentation

  • readme: fix broken ci badge link (bbf6152)
  • readme: sort acknowledgements section (84bf370)
  • readme: use full cjs for example (9d6e702)

3.1.6 (2023-09-23)

Miscellaneous

  • .gitattributes: auto lf eol all files (eb57f24)
  • add missing .gitattributes file (e2ae2a4)
  • change comment blocks with one line into single block (278c87a)
  • eslintrc: bump ecma version to 2023 (92b2f77)
  • jsconfig: set module to nodenext (12ba813)
  • jsconfig: target es2022 (ff4daf0)
  • package: explicitly declare js module type (8dc3dc0)
  • scripts/license-checker: declare copyLeftLicenses type (bb35149)
  • scripts/license-checker: destruct upath module import (#241) (36577f6)
  • scripts/license-checker: ignore invalid ts error (07bee77)
  • use [@see](https://github.com/see) jsdoc tag for inline comment links (96237f6)

Continuous integration

  • dependabot: group dependabot updates (c13c290)
  • deps: bump actions/checkout from 3 to 4 (#243) (dd967c7)
  • deps: bump coverallsapp/github-action from 2.2.1 to 2.2.3 (#244) (a828ccc)

Improvements

  • use node: prefix to bypass require.cache call for builtins (451c618)

Documentation

  • readme: update acknowledgements (4c96c1d)

3.1.5 (2023-08-16)

Dependencies

  • deps-dev: bump dev dependencies (8248c8b)
  • deps-dev: bump eslint-config-prettier from 8.10.0 to 9.0.0 (#234) (81fa53e)
  • deps: bump fastify-plugin from 4.5.0 to 4.5.1 (a052d38)

Miscellaneous

  • .eslintrc: error on google closure jsdoc syntax (39d51b4)
  • add jsconfig; type check js (#236) (b5e9aa0)
  • index: add whitespace between import and comment (a6c22db)
  • jsconfig: add target (f583380)
  • rename lint:prettier scripts to reflect their function (#230) (2fe80ca)
  • scripts/license-checker: use console.error() to log failures (a73d068)

Continuous integration

  • ci: error on new jest snapshot (945eb72)
  • deps: bump coverallsapp/github-action from 2.2.0 to 2.2.1 (#232) (7f1210c)

Improvements

  • scripts/license-checker: deconstruct imports (72ae982)

3.1.4 (2023-07-08)

Miscellaneous

  • .eslintrc: sort extends array (85c67cd)

Dependencies

  • deps-dev: add eslint-plugin-regexp (188fc18)
  • deps-dev: bump dev dependencies (0729fed)

Bug fixes

3.1.3 (2023-06-24)

Continuous integration

  • deps: bump coverallsapp/github-action from 2.1.2 to 2.2.0 (#222) (708c0ce)

Miscellaneous

  • .eslintrc: enable additional jest plugin rules (826b147)
  • .eslintrc: enable additional jsdoc plugin rules (42bcdc8)
  • .eslintrc: only use jest plugin to lint test-related files (ebe852a)
  • .eslintrc: update ecmascript version (7496afa)
  • import fastify type for server jsdoc param (51e3290)
  • package: remove global jest mock config values (8eb8785)
  • package: set jest coverage threshold (2be3725)
  • scripts/license-checker: resolve eslint jsdoc warning (#214) (49964b0)
  • scripts: fix inline comment style (930f92d)
  • use nouns for leading word in function description tags (#216) (fbf9b16)

Dependencies

  • deps-dev: bump dev dependencies (#218) (065c1fa)
  • deps-dev: bump dev dependencies (#223) (22f1481)
  • deps-dev: bump eslint-plugin-jsdoc from 44.2.7 to 46.1.0 (#219) (cf08fb1)

3.1.2 (2023-04-24)

Dependencies

  • deps-dev: bump eslint-plugin-jsdoc from 40.3.0 to 43.0.7 (#211) (cd03cb1)

Continuous integration

  • cd: publish to npm with provenance (#209) (b4675eb)
  • ci: add node 20 to test matrix (#212) (7d68044)
  • deps: bump coverallsapp/github-action from 2.0.0 to 2.1.2 (#210) (4c8d11d)

3.1.1 (2023-04-03)

Documentation

  • changelog: spelling mistake (6316a65)
  • contributing: add link to conventional config (#205) (05abfb9)

Continuous integration

  • dependabot: change commit message prefix for gh actions to ci (#204) (a64a242)
  • deps: bump coverallsapp/github-action from 1.2.4 to 2.0.0 (#206) (07fd161)

Miscellaneous

  • .prettierrc: enable arrowParens option (#208) (115fa90)
  • ignore bun lockfile (#202) (0f08b3b)
  • package: add funding url (387a6cb)
  • scripts: add eslint rule file (d7ac237)
  • scripts: remove redundant export (0651021)
  • scripts: sort eslint comments alphabetically (ff8f707)
  • scripts: use js script to check licenses (#203) (2ec4610)

Dependencies

  • deps-dev: bump dev dependencies (3437b36)
  • deps: bump coverallsapp/github-action from 1.1.3 to 1.2.3 (#200) (97aea4a)
  • deps: bump coverallsapp/github-action from 1.2.3 to 1.2.4 (#201) (e324311)

3.1.0 (2023-02-15)

Features

Dependencies

  • .npmignore: exclude type file (e03c8c9)

Documentation

  • readme: update acknowledgements section (2009401)

3.0.6 (2023-02-13)

Documentation

  • readme: rename intro to overview (5cc350b)

Continuous integration

  • cd: use sentence case for changelog headings (474ad97)

Miscellaneous

  • rename master branch to main (a83d2cc)
  • use sentence case over ap style for titles and headings (4df886d)

Dependencies

  • deps-dev: bump dev dependencies (8f32d55)

3.0.5 (2023-01-31)

Miscellaneous

  • license: update license year (b8af84f)

Documentation

  • contributing: update min node version (e9ba604)
  • grammar and clarity fixes (c1082e9)
  • readme: remove fluff (9349198)

Dependencies

  • deps-dev: bump dev dependencies (0a15f73)
  • deps: bump actions/dependency-review-action from 2 to 3 (#187) (9566dcb)
  • deps: bump fastify-plugin from 4.3.0 to 4.5.0 (3a520f6)

3.0.4 (2022-10-25)

Continuous integration

  • cd: remove dev values from package.json (a35b600)

Dependencies

  • deps-dev: bump dev dependencies (67ccddf)
  • deps: bump fastify-plugin from 4.2.1 to 4.3.0 (44b2403)

3.0.3 (2022-10-03)

Documentation

  • readme: convert sync async example to sync only (9d2c340)
  • readme: remove redundant statement (cec6cbb)
  • use shorter urls; remove yarn install guidance (cd5825b)

Miscellaneous

  • .husky: shell path and arg updates (#179) (de8048c)
  • .npmignore: reduce entries (8b15a2a)
  • .vscode/extensions: remove unmaintained extension (1f0b967)
  • *.ignore: add clinicjs directory (87af308)
  • LICENSE: remove trailing whitespace (8d4b41d)
  • prefer object destructuring (#184) (3f203ad)

Dependencies

  • deps-dev: bump eslint-plugin-jest from 26.9.0 to 27.0.1 (#182) (ca37cd4)
  • deps-dev: bump jest from 28.1.3 to 29.0.1 (#181) (0b7ef81)
  • deps: bump dependencies (9a098db)

3.0.2 (2022-08-09)

Miscellaneous

  • .npmrc: disable package-lock generation (#175) (773710d)

Dependencies

  • .npmignore: add CHANGELOG.md; reduce package size by ~86% (#177) (587aeaa)
  • deps: bump dependencies (#178) (224b215)

3.0.1 (2022-07-25)

Miscellaneous

  • .github/funding: remove unused keys (f5a9dd8)
  • .github: add FUNDING.yml (a07ef55)
  • .gitignore: use latest github ignore template (ae02f4f)
  • .prettierignore: add new paths from .gitignore (15b3075)
  • ignore pnpm lock file (25d16e3)

Dependencies

  • dependabot: increase open-pull-requests-limit from 5 to 20 (932f0cb)
  • deps: bump actions/dependency-review-action from 1 to 2 (#173) (6006239)
  • deps: bump fastify-plugin from 3.0.1 to 4.0.0 (#174) (1de5fd1)
  • deps: bump wagoid/commitlint-github-action from 4 to 5 (#172) (418a2ee)

Documentation

  • readme: update example for fastify v4 (fb33821)

3.0.0 (2022-05-26)

⚠ BREAKING CHANGES

    • Dropped support for Fastify v3.x and Node 10.x

Features

2.0.8 (2022-05-25)

Documentation

  • readme: remove snyk badge (030c25b)

Miscellaneous

  • .eslintrc: enable plugin:jest/style rules (#160) (db557d3)
  • .github/codeql-config: remove quotation marks (80aa591)
  • .github/workflows/link-check: use skip input (17c0cd5)
  • bug_report: use node 18 as placeholder for node-version (7334daa)
  • ci: remove quotation marks from step name (6707b92)
  • use npm install alias (a65f180)

Continuous integration

  • add dependency-review job (9cdc809)
  • automerge: fix context (d993a4f)
  • automerge: set correct contents permission level (9d0cbb7)
  • automerge: squash automerge prs (#149) (fc83968)
  • cd: update org name for release-please-action (e9fe464)
  • cd: use lts/* for node setup in release job (0f70685)
  • check user.login is dependabot instead of actor (#162) (5348042)
  • ci: add node 18 to test matrix (#161) (a7678a2)
  • ci: require unit-tests job to pass for save-pr-number job to run (74d92fb)
  • ci: use lts/* for node setup in lint job (958fadd)
  • ci: use node-version for node matrix key (e3a2651)
  • codeql: only run on pr changes to .html, .js, and .yml files (142d5e7)
  • codeql: resolve missing analyses (199198e)
  • codeql: specify which files to scan during analysis (6b3ebc7)
  • link-check: replace npx linkinator call with github action (16110d7)
  • only trigger dependency-review on pr (166d402)
  • reduce workflow permissions to minimum (afd110d)
  • remove git credentials after checkout (#165) (b79fc99)
  • replace workflow-run-cleanup-action with github concurrency (97a73a9)

Dependencies

  • deps-dev: bump @commitlint/cli from 16.3.0 to 17.0.1 (#168) (565c3bf)
  • deps-dev: bump @commitlint/config-conventional (#167) (44f12bf)
  • deps-dev: bump eslint-plugin-jsdoc from 38.1.6 to 39.2.9 (#157) (13aceae)
  • deps-dev: bump husky from 7.0.4 to 8.0.1 (#166) (4268e75)
  • deps-dev: bump jest from 27.5.1 to 28.0.3 (#158) (0b2fd9d)
  • deps: bump actions/upload-artifact from 2 to 3 (#156) (c292991)
  • deps: bump github/codeql-action from 1 to 2 (#155) (04facf0)

2.0.7 (2022-03-28)

Documentation

Continuous integration

  • add job step names, workflow comments, and whitespace (2ca950a)
  • codeql-analysis: remove unused autobuild step (b507d07)
  • codeql: grant minimum permissions to run; rename file (#145) (980a082)
  • only save pr number artifact for dependabot (426767d)

Dependencies

  • deps-dev: bump eslint-plugin-jsdoc from 37.9.7 to 38.0.6 (620a0f1)
  • deps: bump actions/checkout from 2 to 3 (b1e5b7d)
  • deps: bump actions/checkout from 2 to 3 (96a9d84)

Miscellaneous

  • index: use res instead of reply for response object (#148) (145c76d)
  • scripts: remove redundant gitkraken fix from prepare script (168740e)
  • scripts: use shorter arg aliases; remove debugging args from jest (8cef653)

2.0.6 (2022-02-25)

Documentation

  • readme: clarify on cache-control usage (#136) (370b589)
  • readme: fix nocache link; add header description section (96bfe59)
  • readme: reorder intro section for clarity (aada401)

Miscellaneous

  • .github: remove trailing whitespace (46f4660)

Dependencies

  • dependabot: ignore minor and patch commit-lint updates (#133) (3a516ab)
  • dependabot: major tags no longer need ignore support (3ede58b)
  • dependabot: use default open-pull-requests-limit value (3702d8c)
  • deps-dev: bump dev dependencies (0e71bf0)
  • deps-dev: bump eslint-plugin-jest from 25.7.0 to 26.0.0 (f6d8fad)
  • deps-dev: unpin prettier version (0887ec1)
  • deps: bump actions/github-script from 5 to 6 (5731aa3)
  • deps: bump actions/setup-node from 2 to 3 (c8e7916)

2.0.5 (2022-01-07)

Documentation

  • coc: reduce verbosity (d144c77)
  • contributing: add mention of husky pre-commit hook (5aa3a70)
  • contributing: add step for lint:licenses script (25075f8)

Miscellaneous

  • .prettierrc: only enable bracketSameLine for html (#106) (929c7ff)
  • husky/pre-commit: add lint:licenses script (#116) (8478448)
  • ignore .yarnclean (#117) (173db8e)
  • index: fix server jsdoc tag param type (07befc1)

Continuous integration

  • cd: stop prepare script running (#108) (742e93f)
  • ci: do not run clean-up on draft prs (35aa923)
  • remove spellcheck workflow (#128) (cfb722f)
  • spell-check: do not run on draft prs (c2a0cb5)
  • trigger workflows when drafts marked as "ready to review" (#110) (ad73015)

Dependencies

  • dependabot: ignore minor and patch github-actions updates (#111) (a413612)
  • dependabot: ignore minor and patch release-please-action updates (#120) (c5a783c)
  • deps-dev: bump @commitlint/cli from 13.2.1 to 14.1.0 (bb90b84)
  • deps-dev: bump @commitlint/cli from 14.1.0 to 15.0.0 (8f8a797)
  • deps-dev: bump @commitlint/cli from 15.0.0 to 16.0.1 (d466f26)
  • deps-dev: bump @commitlint/config-conventional (a90f6fd)
  • deps-dev: bump @commitlint/config-conventional (f72d44b)
  • deps-dev: bump @commitlint/config-conventional (cf4d179)
  • deps-dev: bump eslint from 7.32.0 to 8.6.0 (48fa57c)
  • deps-dev: bump eslint-config-airbnb-base from 14.2.1 to 15.0.0 (4163e42)
  • deps-dev: bump eslint-plugin-promise from 5.2.0 to 6.0.0 (d3756b7)
  • deps-dev: bump prettier from 2.4.1 to 2.5.0 (efc5dbf)
  • deps-dev: bump prettier from 2.5.0 to 2.5.1 (370af01)
  • deps: bump GoogleCloudPlatform/release-please-action (e33ed1e)
  • deps: bump GoogleCloudPlatform/release-please-action from 2 to 3 (5955c95)

2.0.4 (2021-10-29)

Continuous integration

  • automerge: update location of octokit rest methods (c489d5a)
  • ci: revert to workflow-run-clean-action from github concurrency (370196e)

Improvements

  • index: sort headers alphabetically ascending (3861633)

Miscellaneous

  • .eslintrc: remove inaccurate sourcetype (#93) (becd14a)
  • .eslintrc: remove redundant impliedStrict option (#95) (d0d5c17)
  • .eslintrc: set correct ecmascript version (#83) (6041b8a)
  • .husky/.gitignore: remove now redundant file (6de6b0f)
  • .prettierrc: enable bracketsameline option (f94d54d)
  • .prettierrc: override defaults for html, css, and scss files (#84) (6cbb18f)
  • .vscode: add mhutchie.git-graph extension (ac4661e)
  • .vscode: remove deprecated settings (#94) (ae36f6c)

Documentation

Dependencies

  • deps-dev: add eslint-plugin-security-node (#85) (cb43451)
  • deps-dev: bump dev dependencies (#103) (f6f03bb)
  • deps-dev: bump eslint-plugin-jest from 24.7.0 to 25.2.2 (ffdf87c)
  • deps-dev: bump eslint-plugin-jsdoc from 36.1.1 to 37.0.3 (6903ce1)
  • deps-dev: bump prettier from 2.3.2 to 2.4.1 (5d09425)
  • deps: bump actions/checkout from 2.3.4 to 2.3.5 (06e070a)
  • deps: bump actions/setup-node from 2.4.0 to 2.4.1 (aefdbb9)
  • deps: bump GoogleCloudPlatform/release-please-action (9977b09)
  • deps: bump GoogleCloudPlatform/release-please-action (ee927de)
  • deps: bump wagoid/commitlint-github-action from 4.1.1 to 4.1.5 (c6b71d9)
  • deps: bump wagoid/commitlint-github-action from 4.1.5 to 4.1.9 (429d412)

2.0.3 (2021-09-06)

Miscellaneous

  • .github: use new YAML configured GitHub issue forms (#79) (8111d0f)
  • vscode: disable red hat telemetry (044e7c8)
  • vscode: remove user space config setting (d654d6a)

Continuous integration

  • ci: replace workflow-run-cleanup-action with github concurrency (#80) (660aeb2)
  • link-check: reduce frequency from daily to monthly (#64) (daae963)

Dependencies

  • add .npmignore; reduce package size from 18.9kB to 8.7kB (#81) (dd849f8)
  • deps-dev: bump @commitlint/cli from 12.1.4 to 13.1.0 (986fe61)
  • deps-dev: bump @commitlint/config-conventional (6885d7c)
  • deps-dev: bump eslint-plugin-jsdoc from 35.5.1 to 36.0.6 (0dea4f4)
  • deps-dev: bump husky from 6.0.0 to 7.0.0 (e871e22)
  • deps-dev: bump prettier from 2.3.1 to 2.3.2 (ce2a3ec)
  • deps: bump actions/github-script from 4.0.2 to 4.1 (6ddce4a)
  • deps: bump actions/setup-node from 2.1.5 to 2.2.0 (3a8d2ab)
  • deps: bump actions/setup-node from 2.2.0 to 2.3.0 (574c081)
  • deps: bump actions/setup-node from 2.3.0 to 2.4.0 (4f16c78)
  • deps: bump coverallsapp/github-action from 1.1.2 to 1.1.3 (83505e3)
  • deps: bump GoogleCloudPlatform/release-please-action (3a62368)
  • deps: bump wagoid/commitlint-github-action from 3.1.4 to 4.1.1 (50a5f36)

2.0.2 (2021-06-17)

Bug fixes

  • index: re-add 'must-revalidate' to cache-control header (#61) (2b814aa), thanks @anthony-telljohann

Dependencies

  • deps: bump actions/upload-artifact from 2.2.3 to 2.2.4 (3fb08a1)

2.0.1 (2021-06-16)

Bug fixes

  • index: update Cache-Control directives to disable cache (#58) (b8cb7dd)

Miscellaneous

  • ci: replace node-version key with shorter node (#50) (6f1451b)
  • workflows: remove stale.yml (052321b)

Continuous integration

  • cd: move perf optimizations and refactoring into same section (af8f6c9)
  • fix key usage in action/setup-node (76e1063)

Documentation

  • readme: grammar and wordiness fixes (4897d71)
  • readme: update contributing section (6784210)

Dependencies

  • deps-dev: bump eslint-plugin-jsdoc from 33.3.0 to 35.1.2 (ca27f43)
  • deps-dev: bump jest from 26.6.3 to 27.0.3 (8f443d6)
  • deps-dev: bump prettier from 2.2.1 to 2.3.0 (ccb6c1b)
  • deps-dev: bump prettier from 2.3.0 to 2.3.1 (be6d0d8)
  • deps: bump GoogleCloudPlatform/release-please-action (7d05ec5)
  • deps: bump wagoid/commitlint-github-action from 3.1.0 to 3.1.4 (32fd2b0)

2.0.0 (2021-04-30)

⚠ BREAKING CHANGES

  • remove support for nodejs v10, as it is EOL as of 2021-04-30

Continuous integration

  • add cleanup-run job (c67a547)
  • add nodejs v16 to unit test matrix (1edc6e6)
  • do not run coveralls steps/jobs on forks (80b41a8)
  • link-check: fix skip regex (1e28e0e)

Miscellaneous

  • remove support for nodejs v10 (b9d8df6)
  • update descriptions (2ebb643)

Documentation

  • grammar and readability fixes (3b94c36)

Dependencies

  • deps-dev: bump eslint-plugin-jsdoc from 32.3.4 to 33.0.0 (2b6db53)
  • deps-dev: bump eslint-plugin-promise from 4.3.1 to 5.1.0 (2450e9f)
  • deps: bump actions/github-script from v3.1.0 to v3.1.1 (6b53317)
  • deps: bump actions/github-script from v3.1.1 to v4.0.2 (b352e90)
  • deps: bump actions/upload-artifact from v2.2.2 to v2.2.3 (fdd2b61)
  • deps: bump GoogleCloudPlatform/release-please-action (7fc4c9c)
  • deps: bump typoci/spellcheck-action from v0.4.0 to v1.1.0 (0ae1b92)
  • deps: bump wagoid/commitlint-github-action from v3.0.6 to v3.1.0 (b370d57)

1.0.6 (2021-03-30)

Documentation

  • changelog: add h1 header (d9ab1ff)

Miscellaneous

  • package: move prettier config to separate file (6acf338)
  • prettier: create .prettierignore (6e7a390)
  • prettierignore: add lock files (d739db1)
  • workflows: rename ci and perf sections (60783a0)

Continuous integration

  • automerge: move automerge job into new workflow (f16c26f)
  • ci: ignore dependabot prs for commit message linting (38fcc82)
  • stale: shorten workflow name (c5d7ab5)
  • workflows: fix release types to account for bots (915459f)
  • workflows: move release steps into cd workflow (b8743a3)
  • workflows: run only on push and pulls to main branch (d4f685e)

Dependencies

  • deps-dev: bump husky from 4.3.8 to 6.0.0 (b23680a)
  • deps: bump actions/stale from v3.0.17 to v3.0.18 (f641b97)
  • deps: bump GoogleCloudPlatform/release-please-action (5ad997a)
  • deps: bump typoci/spellcheck-action from v0.3.0 to v0.4.0 (0f2b264)
  • deps: bump wagoid/commitlint-github-action from v3.0.1 to v3.0.6 (eab4a3c)

1.0.5 (2021-03-01)

Documentation

  • contributing: add documentation style (ea3f3c9)
  • readme: correct spelling (43b1fb6)
  • readme: fix broken link (eeb49c5)
  • readme: shorten links (8f0402d)

Miscellaneous

  • add 0bsd and unlicense to list of allowed licenses (16e5418)
  • add apache-2.0 to list of allowed licenses (355ebf0)
  • add commit-lint job (a796f68)
  • add commitlint husky commit-msg hook (ea8c5b5)
  • add link check workflow (8361653)
  • automate release and changelog generation (3c2c6bf)
  • check direct dependency licenses only (99d9b28)
  • codeql: remove autobuild action (c56a6e7)
  • dependabot: ignore husky updates (5b7528c)
  • deps-dev: bump @commitlint/cli from 11.0.0 to 12.0.1 (#20) (03ffa38)
  • deps-dev: bump @commitlint/config-conventional (f7e3805)
  • deps-dev: bump eslint-config-prettier from 7.2.0 to 8.1.0 (479a47b)
  • deps-dev: bump eslint-plugin-jsdoc from 31.6.1 to 32.0.1 (#16) (e17488b)
  • deps: bump wagoid/commitlint-github-action from v2.0.3 to v2.2.3 (#15) (3335bd5)
  • deps: bump wagoid/commitlint-github-action from v2.2.3 to v3.0.1 (93422e6)
  • license checker tweak (9d3f824)
  • linkcheck: extend ignored urls (3ba2af8)
  • lint-check: compress patterns (b936d36)
  • readme: add linebreaks between badges (5a7835c)
  • replace stalebot with github action (b8c2bf8)
  • replace typo ci app with action (17d74b1)
  • require commit-lint job to pass before automerge (d19b53e)
  • scripts: rename jest-coverage to jest:coverage (962ad6f)
  • shorten husky pre-push script (b35aa25)
  • tests: use apa header style for describe name params (dcd6651)
  • vscode: add redhat.vscode-yaml as recommended extension (2904f20)
  • vscode: add updateImportsOnFileMove setting (cee4b73)
  • vscode: add workspace settings and extensions (1dda7c6)
  • vscode: remove conflicting prettier ext setting (d50e57b)
  • workflows: rename spellcheck workflow (46a6b1e)
  • workflows: tidy node-version syntax (15cf4f1)

Dependencies

  • dependabot: set commit message prefix; lower pull limit (8e0ca65)
  • deps-dev: pin husky major version (0b671ad)
  • deps: specify minor and hotfix versions (a9f9cee)

1.0.4 (2021-02-01)

  • ci: add production license checking (d32c299)
  • ci: remove cache actions as they use lock file (3893a36)
  • ci: remove cache actions as they use lock file (333782f)
  • ci(github-actions): set flag-name for parallel coverage tests (b8f2df5)
  • ci(github-actions): set semver for coverallsapp (cec67d4)
  • docs: bump coc from v1.4.0 to v2.0.0 (f038609)
  • docs(readme): reorder intro paragraph (45c1de5)
  • docs(readme): sentence restructure (2dfdcc0)
  • chore: stop excess coverage files being generated (f2b8925)
  • build(deps-dev): add husky for git hook handling (776cd18)
  • build(deps-dev): remove coveralls, replaced by github action (170ee64)
  • style: capitalise headings correctly (be8a2bf)
  • style(ci): capitalise jobs and job step names (74b2796)
  • style(readme): capitalise headings correctly (73f94aa)
  • style(readme): prettier badge shape (1379c12)

1.0.3 (2021-01-18)

  • fix: remove lockfile (956b481)
  • ci: ignore scripts on publish (fb7546c)
  • ci(typo-ci): add ydh to list of excluded words (9f17731)

1.0.2 (2021-01-17)

  • build: remove yarn as package manager, revert to npm (fcc1463)
  • build(deps-dev): bump dev dependencies (8e32b0b)
  • refactor(index): use async rather than callback (4eca59c)
  • chore(package): add homepage and bug urls (9403163)
  • docs: add security.md (7a919c1)
  • docs: update contact email (6c7fedd)
  • ci: remove redundant javascript dictionary (1dcbda2)
  • test(index): remove redundant mock reset call (63152cc)

1.0.1 (2021-01-12)

  • chore(deps-dev): bump eslint-plugin-jsdoc from 31.0.2 to 31.0.3 (#3) (f8ad694), closes #3
  • refactor: remove nocache dependency; set headers directly (858aa94)
  • ci(github-actions): move codeql action to correct folder (5e6655b)

1.0.0 (2021-01-11)