@milaboratories/pframes-rs-node
v1.0.109
Published
PFrames - Node.js Native Addon
Downloads
2,162
Readme
PFrames Node.js native addon
Usage
[!TIP] Install using
pnpm install @milaboratories/pframes-rs-nodecommand. Check tests for usage examples.
Build instructions
Build steps
pnpm run buildArtifacts
NodeJS Native Addon is places in dist folder.
Use pnpm run pack to prepare an archive (last output line is its path) and upload it to AWS S3.
Export wrapper is placed in export_dist folder.
Use pnpm publish to publish NodeJS package.
Debugging
Prerequisites
Debugging is only supported using VSCode with the following extencions installed (check @recommended section in VScode for more suggestions):
Launching debug session
- Clone and build the latest
platforma-desktop-v2(git clean -dffx && npm i && npm run build) - Set the correct RELATIVE path to
platforma-desktop-v2in.vscode/settings.jsonvariableplatformaDesktopPath(default is../platforma-desktop-v2) - Build this package by following the build steps from above (for faster build use
pnpm run dev-build) - Use VSCode launch configuration for your platform to start debug session (VSCode debugging guide)
Performance profiling
- Clone and build the latest
platforma-desktop-v2 - Set the correct RELATIVE path to
platforma-desktop-v2in.vscode/settings.jsonvariableplatformaDesktopPath - Build this package by following the build steps from above
- Launch VSCode task (Cmd+Shift+P -> Tasks: Run Task -> Perf-profile platforma-desktop) for profiling
- Execute the test scenario and quite platforma-desktop
- Firefox profiler with recorded performance profile would automatically open in you browser of choice (Warning! Firefox profiler does not work in Safari and with AdBlock enabled)
Dump pframes requests
- Run
platforma-desktop-v2withMI_DUMP_PFRAMES_RS=/absolute/path/to/dump/requests npm run dev - Archive the
/absolute/path/to/dump/requestsfolder and pass to the developer
