Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
doc
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Stix wetland

Slack Status

A stix module for Wetland ORM.

Setup

If you initialized a new stix project using the boards cli stix preset, stix-wetland will already be included in your project and you can move on to the using section. If not, keep reading.

  1. In your stix project, simply run yarn add stix-wetland.
  2. Add the module to your project's src/config/modules.ts:
import { ModuleManagerConfigInterface } from 'stix';
import { Wetland } from 'stix-wetland';

export const modules: ModuleManagerConfigInterface = [
  Wetland,
  // Your other modules.
];

Setting up wetland

Configuring wetland can be done by adding a wetland key to your config.

  1. Add export * from './wetland'; to your src/config/index.ts.
  2. Create a file at src/config/wetland.ts and add export const wetland = {} to it.
  3. Configure wetland to your heart's desire.

You can find more info about the configuration options in the wetland documentation.

Note: Due to the nature of stix's module system, all configs conveniently get merged. This means that you could add a config/wetland.ts to each of your modules specifying the entityPaths[] for those module's entities.

Documentation

Take a look at the doc/ directory to find documentation.

License

MIT.

About

🎩 A stix module that brings Wetland ORM to your project, including helpers and a criteria parser.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •