Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lykmapipo/mongoose-geojson-schemas
mongoose schema to support geojson fields
https://github.com/lykmapipo/mongoose-geojson-schemas
geojson geometry linestring mongoose multipoint point polygon schema
Last synced: 3 days ago
JSON representation
mongoose schema to support geojson fields
- Host: GitHub
- URL: https://github.com/lykmapipo/mongoose-geojson-schemas
- Owner: lykmapipo
- License: mit
- Created: 2018-05-02T08:58:54.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-07-27T05:41:41.000Z (about 2 years ago)
- Last Synced: 2024-09-19T17:32:48.738Z (7 days ago)
- Topics: geojson, geometry, linestring, mongoose, multipoint, point, polygon, schema
- Language: JavaScript
- Size: 1.62 MB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# mongoose-geojson-schemas
[](https://app.travis-ci.com/lykmapipo/mongoose-geojson-schemas)
[](https://david-dm.org/lykmapipo/mongoose-geojson-schemas)
[](https://coveralls.io/github/lykmapipo/mongoose-geojson-schemas?branch=master)
[](https://github.com/lykmapipo/mongoose-geojson-schemas/blob/master/LICENSE)
[](http://commitizen.github.io/cz-cli/)
[](https://github.com/prettier/prettier)
[](https://github.com/airbnb/javascript)
[](https://www.npmjs.com/package/mongoose-geojson-schemas)
mongoose schema to support [GeoJSON](http://geojson.org/geojson-spec.html) fields.
*Note: All geojson types will added as single-embedded document(sub-schema) and `2dsphere` indexed*
## Requirements
- [NodeJS v13+](https://nodejs.org)
- [Npm v6.12+](https://www.npmjs.com/)
- [MongoDB v4+](https://www.mongodb.com/)
- [Mongoose v6+](https://github.com/Automattic/mongoose)
## Installation
```sh
npm install mongoose mongoose-geojson-schemas --save
```
## Usage
```js
import { Schema } from 'mongoose';
import {
Point,
LineString,
Polygon,
MultiPoint,
MultiLineString,
MultiPolygon,
Geometry,
GeometryCollection,
} from 'mongoose-geojson-schemas';
// define Point
const Shop = new Schema({
name: { type: String, required: true },
location: Point,
});
// define LineString
const Road = new Schema({
name: { type: String, required: true },
footpath: LineString,
});
// define Polygon
const Farm = new Schema({
owner: { type: String, required: true },
boundary: Polygon,
});
// define MultiPoint
const Dump = new Schema({
name: { type: String, required: true },
area: MultiPoint,
});
// define MultiLineString
const Rail = new Schema({
name: { type: String, required: true },
ways: MultiLineString,
});
// define MultiPolygon
const Jurisdiction = new Schema({
name: { type: String, required: true },
boundaries: MultiPolygon,
});
// define Geometry
const Shape = new Schema({
name: { type: String, required: true },
form: Geometry,
});
// define GeomentryCollection
const Trash = new Schema({
name: { type: String, required: true },
pile: GeometryCollection,
});
```
## Testing
- Clone this repository
- Install all development dependencies
```sh
npm install
```
- Run example
```sh
npm run dev
```
- Then run test
```sh
npm test
```
## Contribute
It will be nice, if you open an issue first so that we can know what is going on, then, fork this repo and push in your ideas. Do not forget to add a bit of test(s) of what value you adding.
## License
The MIT License (MIT)
Copyright (c) lykmapipo & Contributors
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.