rrweb docs

English

简体中文

English

简体中文

@rrweb/types ​

Overview ​

This package contains the shared types used across rrweb packages. rrweb makes extensive use of typescript types to enforce correctness and define the data API between packages. Check out the Events doc for an introduction to the principal Event type. View the source code to get a flavour the types available, or check out the Contributor Guide for more info.

Edit README on GitHub

Release Notes for @rrweb/types ​

2.1.1 ​

No changes in this release, version bump to keep in sync with other packages

2.1.0 ​

Minor Changes ​

2.0.1 ​

No changes in this release, version bump to keep in sync with other packages

2.0.0 ​

Major Changes ​

  • #1497 2606a2a Thanks @Juice10! - Distributed files have new filenames, paths and extensions. Important: If you reference distributed files or types directly, you might have to update your paths/filenames. E.g. you import from rrweb/typings/... or rrdom/es. However you run import rrweb from 'rrweb' you won't notice a difference with this change. If you include rrweb files directly in a script tag, you might have to update that path to include a the .umd.cjs files instead. All .js files now use ES modules which can be used in modern browsers, node.js and bundlers that support ES modules. All npm packages now also ship .cjs and .umd.cjs files. The .umd.cjs files are CommonJS modules that bundle all files together to make it easy to ship one file to browser environments (similar to the previous .js files). The .cjs files are CommonJS modules that can be used in older Node.js environments. Types should be better defined in package.json and if you need specific types they might be exported from new packages (for example PlayerMachineState and SpeedMachineState are now exported from @rrweb/replay). Check the package.json's main and exports field for the available files.

  • #1031 ad9bc3e Thanks @Juice10! - Move shared rrweb event and recorder types into the new @rrweb/types package.

Minor Changes ​

Patch Changes ​

  • #1833 0f0a532 Thanks @Juice10! - Add public asset event type aliases for the 2.0 event contract.

  • #1268 d872d28 Thanks @eoghanmurray! - Compact style mutation fixes and improvements

    • fixes when style updates contain a 'var()' on a shorthand property #1246
    • further ensures that style mutations are compact by reverting to string method if it is shorter

  • #1287 efdc167 Thanks @Juice10! - Upgrade all projects to typescript 4.9.5

  • #1432 123a81e Thanks @Juice10! - Add loop to mediaInteractionParam

  • #1704 33e01f5 Thanks @eoghanmurray! - Provide a /umd/ output folder alongside the /dist/ one so that we can serve UMD (Universal Module Definition) files with a .js extension, without upsetting expectations set by package.json that all .js files in /dist/ are modules

  • #1369 c278d06 Thanks @stefansundin! - Fix type error when using "moduleResolution": "NodeNext".

  • Updated dependencies [2a80949]:

    • rrweb-snapshot@2.0.0-alpha.4

2.0.0-alpha.17 ​

Minor Changes ​

Patch Changes ​

2.0.0-alpha.16 ​

Patch Changes ​

  • Updated dependencies [a2c8a1a, d08624c]:
    • rrweb-snapshot@2.0.0-alpha.16

2.0.0-alpha.15 ​

Major Changes ​

  • #1497 2606a2a Thanks @Juice10! - Distributed files have new filenames, paths and extensions. Important: If you reference distributed files or types directly, you might have to update your paths/filenames. E.g. you import from rrweb/typings/... or rrdom/es. However you run import rrweb from 'rrweb' you won't notice a difference with this change. If you include rrweb files directly in a script tag, you might have to update that path to include a the .umd.cjs files instead. All .js files now use ES modules which can be used in modern browsers, node.js and bundlers that support ES modules. All npm packages now also ship .cjs and .umd.cjs files. The .umd.cjs files are CommonJS modules that bundle all files together to make it easy to ship one file to browser environments (similar to the previous .js files). The .cjs files are CommonJS modules that can be used in older Node.js environments. Types should be better defined in package.json and if you need specific types they might be exported from new packages (for example PlayerMachineState and SpeedMachineState are now exported from @rrweb/replay). Check the package.json's main and exports field for the available files.

Patch Changes ​

2.0.0-alpha.14 ​

Patch Changes ​

2.0.0-alpha.13 ​

Patch Changes ​

2.0.0-alpha.12 ​

Patch Changes ​

2.0.0-alpha.11 ​

Patch Changes ​

2.0.0-alpha.10 ​

Patch Changes ​

  • #1268 d872d28 Thanks @eoghanmurray! - Compact style mutation fixes and improvements

    • fixes when style updates contain a 'var()' on a shorthand property #1246
    • further ensures that style mutations are compact by reverting to string method if it is shorter

  • Updated dependencies [c6600e7]:

    • rrweb-snapshot@2.0.0-alpha.10

2.0.0-alpha.9 ​

Patch Changes ​

  • Updated dependencies [d7c72bf]:
    • rrweb-snapshot@2.0.0-alpha.9

2.0.0-alpha.8 ​

Minor Changes ​

Patch Changes ​

2.0.0-alpha.5&mdash7 ​

Patch Changes only following changes to rrweb-snapshot

Patch Changes ​