UNPKG

max-api

Version:

Placeholder / Stub Node package for users that accidentally install "max-api" when attempting to use the dynamic "max-api" within [node.script]

github.com/Cycling74/n4m-max-api

Cycling74/n4m-max-api

13 lines (7 loc) • 734 B
1
2
3
4
5
6
7
8
9
10
11
12
13
# max-api ## Intro This package is simply a placeholder package to prevent malicious usage of the `max-api` package name. It simply throws an error when required in order to showcase that a user has accidentally installed a `max-api` package when using `[node.script]`. ## Background When using `[node.script]`in [Cycling '74](http://cycling74.com) Max one gets access to an API that allows bi-directional communication between Node and Max. This API is made dynamically available and can be required using `require("max-api")`. To avoid any issues or unexpected behaviour with an installed dependency of `max-api` that might overwrite the dynamic API module this package immediately throws an error. ## License [MIT](./LICENSE)