npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@yaga/generic-geojson

v1.0.0

Published

Enhancement of the original GeoJSON type definition for TypeScript

Downloads

218

Readme

Generic GeoJSON type definition

This is just a type definition and an enhancement of the original GeoJSON type definition for TypeScript.

You can use this definition to handle generic properties of features in GeoJSON.

How to use

Just install this definition with:

npm install --save @yaga/generic-geojson

and import into your TypeScript source:

import { GenericGeoJSONFeature, GenericGeoJSONFeatureCollection } from '@yaga/generic-geojson';

Background

The specification of GeoJSON allows every data type for the properties property. In lots of use-cases you want to specify the properties to a special (generic) one. With this definition you are able to do so.

Example

Every GeoJSON is compatible to the generic one with the any type:


import OriginalFeature = GeoJSON.Feature;
import GeometryObject = GeoJSON.GeometryObject;
import { GenericGeoJSONFeature } from '@yaga/generic-geojson';

let aFeature: OriginalFeature<GeometryObject> = {
    type: 'Feature',
    geometry: {
        type: 'Point',
        coordinates: [1, 2]
    },
    properties: {
        all: 'should',
        be: true
    }
};

// This is valid!
let aGenericFeatureWithAny: GenericGeoJSONFeature<GeometryObject, any> = aFeature;

The first generic have the same meaning like the one from the original GeoJSON definition. Additionally you are able to specify the properties more precise with the second generic:


import GeometryObject = GeoJSON.GeometryObject;
import { GenericGeoJSONFeature } from '@yaga/generic-geojson';

interface TestInterface {
    just: boolean;
    specific: string;
    properties?: number;
}

let aSpecifiedFeature: GenericGeoJSONFeature<GeometryObject, TestInterface> = {
    type: 'Feature',
    geometry: {
        type: 'Point',
        coordinates: [1, 2]
    },
    // properties must fulfill the TestInterface!
    properties: {
       just: true,
       specific: '',
       properties: 123
    }
};

The same for FeatureCollections:


import GeometryObject = GeoJSON.GeometryObject;
import { GenericGeoJSONFeature, GenericGeoJSONFeatureCollection } from '@yaga/generic-geojson';

interface TestInterface {
    just: boolean;
    specific: string;
    properties: number;
}

let aSpecifiedFeature: GenericGeoJSONFeature<GeometryObject, TestInterface> = {
    type: 'Feature',
    geometry: {
        type: 'Point',
        coordinates: [1, 2]
    },
    properties: {
       just: true,
       specific: '',
       properties: 123
    }
};

// Same meaning for FeatureCollections:
let aSpecificFeatureCollection: GenericGeoJSONFeatureCollection<GeometryObject, TestInterface> = {
    type: 'FeatureCollection',
    features: [ aSpecifiedFeature ]
}