osm2geojson-lite 2.0.1 → 2.1.0

package/dist/index.d.ts

@@ -1,4 +1,3 @@
-//#region node_modules/@types/geojson/index.d.ts
 /**
  * The value values for the "type" property of GeoJSON Objects.
  * https://tools.ietf.org/html/rfc7946#section-1.4
@@ -174,8 +173,14 @@ interface FeatureCollection<G extends Geometry | null = Geometry, P = GeoJsonPro
   type: "FeatureCollection";
   features: Array<Feature<G, P>>;
 }
-//#endregion
-//#region src/index.d.ts
+type PolygonRule = {
+  ignore?: string[];
+  include?: string[];
+  exclude?: string[];
+  whitelist?: string[];
+  blacklist?: string[];
+};
+type PolygonTags = Record<string, PolygonRule>;
 interface IOptions {
   /**
    * When it's set to `true`, the returned geojson will include all elements that meet the specified conditions in `FeatureCollection` format;
@@ -195,9 +200,27 @@ interface IOptions {
    * @default true
    */
   excludeWay?: boolean;
+  /**
+   * An OSM element ID in the form of `type/id`, e.g. `way/123`. When set, only that
+   * feature is returned instead of a `FeatureCollection`.
+   * @default undefined
+   */
+  elementId?: string;
+  /**
+   * When set to `true`, features that reference missing nodes/ways/relations
+   * receive an `@tainted: true` property. Matches `osm2geojson-ultra`.
+   * @default false
+   */
+  tainted?: boolean;
+  /**
+   * Alternate polygon tag rules for ways. The shape matches `polytags.json`:
+   * `{ key: { ignore?, include?, exclude? } }`. Legacy `whitelist` /
+   * `blacklist` spellings are also accepted.
+   * @default undefined (built-in rules)
+   */
+  polygonTags?: PolygonTags;
 }
 declare function osm2geojson(osm: string | {
   [k: string]: any;
-}, opts?: IOptions): FeatureCollection<GeometryObject>;
-//#endregion
+}, opts?: IOptions): FeatureCollection<GeometryObject> | Feature<any, any> | GeometryObject | undefined;
 export { osm2geojson as default };