openreplay/sourcemap-uploader/README.md
2021-06-23 20:48:47 +02:00

1.2 KiB

sourcemap-uploader

An NPM module to upload your JS sourcemap files to your OpenReplay instance.

Installation

npm i -D @openreplay/sourcemap-uploader

CLI

Upload sourcemap for one file:

sourcemap-uploader -s https://opnereplay.mycompany.com/api -k API_KEY -p PROJECT_KEY file -m ./dist/index.js.map -u https://myapp.com/index.js

Upload all sourcemaps in a given directory. The URL must correspond to the root where you upload JS files from the directory. In other words, if you have your app-42.js along with the app-42.js.map in the ./build folder and then want to upload it to your OpenReplay instance so it can be reachable through the link https://myapp.com/static/app-42.js, then the command should be like:

sourcemap-uploader -s https://opnereplay.mycompany.com/api -k API_KEY -p PROJECT_KEY dir -m ./build -u https://myapp.com/static
  • Use -s (--server) to specify the URL of your OpenReplay instance (make to append it with /api)
  • Use -v (--verbose) to see the logs.

NPM

There are two functions inside index.js of the package:

uploadFile(api_key, project_key, sourcemap_file_path, js_file_url)
uploadDir(api_key, project_key, sourcemap_dir_path, js_dir_url)

Both functions return Promise.