moleculer-postgis

Save, validate and parse geometries on your @moleculer/database project

Table of Contents

• About the Project
• Getting Started
• Usage
• Contributing
• License

About the Project

The moleculer-postgis is designed to support Postgis functions for @moleculer/database mixin.

Getting Started

To get started, install moleculer-postgis package to your project.

npm i moleculer-postgis
yarn add moleculer-postgis

Usage

import PostgisMixin from 'moleculer-postgis';

module.exports = {
  mixins: [
    PostgisMixin: {
      srid: 3346
    }
  ],

  settings: {
    fields: {
      // example with geom and validating types
      geom: {
        type: 'any',
        geom: {
          types: ['Point', 'LineString']
        }
      },
      area: {
        type: 'number',
        virtual: true,
        geom: {
          type: 'area',
        }
      }
    }
  }
};

Contributing

Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request. For more information, see the contribution guidelines.

License

This project is licensed under the MIT License.