How to Run the Examples

To become more familiar with the Aspose.Words possibilities and features we provide examples that can be downloaded from our GitHub repository, run, and learn in detail.

In this article, you can find the system requirements, as well as information on how to run the examples.

Software Requirements and Prerequisites

Please make sure you have Node.js 14.17.0 or later installed on yout PC.

Download and Run the Examples

All Aspose.Words for Node.js via .NET examples are hosted on GitHub. You can either clone the repository using your favorite GitHub client or download the ZIP file.

After getting a copy of the repository, you may find that:

All the examples are located in the ApiExamples and DocExamples folder.
All the examples are unit tests.

To run the examples, open your favorite command prompt:

Change the directory to the ApiExamples or DocExamples folder.
Run all tests with the command:
```
npm test
```
Run specific tests only, for example ExBookmarks.test.js:
```
jest --findRelatedTests ExBookmarks.test.js
```

Please feel free to reach out using our Aspose.Words Product Family Forum if you have any issues setting up or running the examples.

Contribute to Improving the Examples

If you like to add or improve an example, we encourage you to contribute to the project. All examples and showcase projects in this repository are open source and can be freely used in your applications.

You can fork the repository, edit the source code, and create a pull request to contribute. We will review the changes and include them in the repository if found helpful.

FAQ

Q: Do I need a license file to run the example tests?
A: The examples are shipped with a temporary trial license, so they run out‑of‑the‑box. If you want to test your own license, replace the License file in the project root with your license file and ensure the code loads it before any Aspose.Words API calls.
Q: Which version of Node.js is required for the examples?
A: The examples require Node.js 14.17.0 or later. Using an older version may cause syntax errors or missing module support. You can verify your version with node -v.
Q: How can I run a single example test instead of all tests?
A: Use the Jest command with the --findRelatedTests option followed by the test file name, e.g., jest --findRelatedTests ExBookmarks.test.js. This runs only the specified test and its dependencies.
Q: What should I do if npm test fails with missing modules or other errors?
A: First run npm install in the ApiExamples or DocExamples folder to restore all required packages. If the problem persists, delete the node_modules folder and the package-lock.json file, then run npm install again. Ensure you have an active internet connection and that your proxy settings (if any) allow npm to download packages.

Hello, World! Features