Base Path#

The Base Path refers to the access path prefix for static resources (such as JavaScript, CSS, images, etc.) in an application. In Esmx, proper configuration of the base path is crucial for the following scenarios:

• Multi-environment Deployment: Supports resource access across different environments like development, testing, and production
• Multi-region Deployment: Adapts to cluster deployment requirements in different regions or countries
• CDN Distribution: Enables global distribution and acceleration of static resources

Default Path Mechanism#

Esmx employs an automatic path generation mechanism based on the service name. By default, the framework reads the name field from the project's package.json to generate the base path for static resources: /your-app-name/.

1{
2    "name": "your-app-name"
3}

This convention-over-configuration design offers the following advantages:

• Consistency: Ensures all static resources use a unified access path
• Predictability: The resource access path can be inferred directly from the name field in package.json
• Maintainability: Eliminates the need for additional configuration, reducing maintenance costs

Dynamic Path Configuration#

In real-world projects, we often need to deploy the same codebase to different environments or regions. Esmx provides support for dynamic base paths, enabling applications to adapt to various deployment scenarios.

Use Cases#

Subdirectory Deployment#

Independent Domain Deployment#

Configuration Method#

Through the base parameter of the esmx.render() method, you can dynamically set the base path based on the request context:

1const render = await esmx.render({
2    base: '/cn',  // Set base path
3    params: {
4        url: req.url
5    }
6});