NPM Package Support (Experimental)
    • Dark
      Light
    • PDF

    NPM Package Support (Experimental)

    • Dark
      Light
    • PDF

    Article summary

    As of Apps-Engine v1.28.0 (released in Rocket.Chat v4.0), Rocket.Chat Apps include a subset of NPM packages as dependencies to be used at runtime. While we could not determine the list of all packages that are supported (due to the sheer amount of options available), based on the technical constraints of our implementation, we know that:

    • Utility packages that are not dependent on NodeJS' native modules should work (for example, lodash, momentjs, etc).

    • Packages that create any server, be it HTTP, TCP, UDP, or IPC, will not work (for example, express, hapi, etc).

    • Packages that interact with the fs and os modules will not work.

    If you try using a package that should work but isn't, open an issue in the Rocket.Chat.Apps-engine repository and we'll check it out!

    When using NPM packages in your app, make sure to use the latest rc-apps version (v1.10.1 at the time of this writing) - it is responsible for bundling the code of the packages along with the app's source code.


    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.
    ESC

    Eddy AI, facilitating knowledge discovery through conversational intelligence