FAQ

This section covers some frequently asked questions and important technical considerations when developing Sliprail extensions.

Q: Can my extension use native Node.js modules?

A: No. Sliprail extensions do not support native Node.js modules (i.e., those that require compilation with tools like node-gyp). Extensions should be built with pure JavaScript/TypeScript to ensure compatibility and stability across different operating systems and environments.

Q: What APIs are available to me?

A: Your extension can leverage:

• The full suite of Node.js APIs and built-in modules.
• Sliprail-specific APIs provided by the @sliprail/sdk package.

Q: How will users discover my extension?

A: Currently, third-party extensions are not automatically showcased on the Sliprail website. Users can discover and install your extension through links you share. In the future, we may feature popular extensions on our official site.

Q: Do I need to handle dependencies myself?

A: Yes. As covered in the "Project Structure" section, Sliprail does not run npm install for your extension. You must bundle all dependencies with your code.