\ No newline at end of file
diff --git a/functions/loader.loader.html b/functions/loader.loader.html
index eb0421e..d363ca9 100644
--- a/functions/loader.loader.html
+++ b/functions/loader.loader.html
@@ -1,8 +1,8 @@
-
Function loader
- loader(this, content): void
- \ No newline at end of file +
Main OverpassQL webpack loader function.
+loader | OverpassQL Loader Function loader
- loader(this, content): void
Main OverpassQL webpack loader function.
Parameters
- this: LoaderContext<Options>
the webpack loader context
- content: string
OverpassQL content
-
Returns void
Description
Consumes OverpassQL source content and transforms it into a +
- this: LoaderContext<Options>
Returns void
Throws
when
+this(loader context) is not provided
Function defaultPropertiesFilter
- default
Properties Filter(properties): GeoJsonProperties - \ No newline at end of file diff --git a/functions/properties.hasProperties.html b/functions/properties.hasProperties.html index 0c14fb6..300b403 100644 --- a/functions/properties.hasProperties.html +++ b/functions/properties.hasProperties.html @@ -1,5 +1,5 @@ -
The default OpenStreetMaps properties and tags filter. +
defaultPropertiesFilter | OverpassQL Loader \ No newline at end of file +Function defaultPropertiesFilter
The default OpenStreetMaps properties and tags filter. This removes everything but names and addresses.
-Parameters
- properties: GeoJsonProperties
Key-value object containing OpenStreetMap tags
+
hasProperties | OverpassQL Loader Function hasProperties
- has
Properties(obj?): boolean - \ No newline at end of file diff --git a/functions/properties.isTraversible.html b/functions/properties.isTraversible.html index 8d4a741..0af6263 100644 --- a/functions/properties.isTraversible.html +++ b/functions/properties.isTraversible.html @@ -1,5 +1,5 @@ -
Helper function to determine whether an object contains OpenStreetMaps +
hasProperties | OverpassQL Loader \ No newline at end of file +Function hasProperties
isTraversible | OverpassQL Loader Function isTraversible
- is
Traversible(obj?): boolean - \ No newline at end of file diff --git a/functions/properties.processProperties.html b/functions/properties.processProperties.html index 4e5f783..f1d7240 100644 --- a/functions/properties.processProperties.html +++ b/functions/properties.processProperties.html @@ -1,6 +1,6 @@ -
Helper function to determine whether an object is a real traversible +
isTraversible | OverpassQL Loader \ No newline at end of file +Function isTraversible
processProperties | OverpassQL Loader \ No newline at end of file diff --git a/functions/syntax.stripComments.html b/functions/syntax.stripComments.html index 06da3cc..a438743 100644 --- a/functions/syntax.stripComments.html +++ b/functions/syntax.stripComments.html @@ -1,4 +1,4 @@ -Function processProperties
- process
Properties(geojson, filter?): GeoJsonProperties Helper function to process OpenStreetMaps GeoJSON with the supplied filter +
processProperties | OverpassQL Loader \ No newline at end of file +Function processProperties
- process
Properties(geojson, filter?): GeoJsonProperties Helper function to process OpenStreetMaps GeoJSON with the supplied filter function. Scans the entire object at multiple levels for filtering.
Parameters
- geojson: GeoJsonProperties | FeatureCollection<Geometry, GeoJsonProperties>
OpenStreetMaps GeoJSON object
- Optionalfilter: PropertiesFilterfiltering function
+Optionalfilter: PropertiesFilterfiltering function
Returns GeoJsonProperties
OpenStreetMaps GeoJSON object after filtering with the function
-- geojson: GeoJsonProperties | FeatureCollection<Geometry, GeoJsonProperties>
- process
stripComments | OverpassQL Loader \ No newline at end of file diff --git a/functions/syntax.stripWhitespace.html b/functions/syntax.stripWhitespace.html index c0df9d2..2b7772a 100644 --- a/functions/syntax.stripWhitespace.html +++ b/functions/syntax.stripWhitespace.html @@ -1,4 +1,4 @@ -Function stripComments
stripWhitespace | OverpassQL Loader \ No newline at end of file diff --git a/index.html b/index.html index 904e00d..16c0754 100644 --- a/index.html +++ b/index.html @@ -1,4 +1,4 @@ -Function stripWhitespace
OverpassQL Loader \ No newline at end of file diff --git a/modules/loader.html b/modules/loader.html index 045fb60..cfa9b56 100644 --- a/modules/loader.html +++ b/modules/loader.html @@ -1,5 +1,5 @@ -OverpassQL Loader
+OverpassQL Loader \ No newline at end of file +OverpassQL Loader
-
@@ -9,13 +9,12 @@
OverpassQL Loader
+-
-
+
-
-
This Webpack loader allows you to pull in OverpassQL files as strings, providing seamless integration of OpenStreetMap data into your application.
@@ -23,58 +22,63 @@OverpassQL Loader
your Webpack build process, but it also optionally caches the responses from an Overpass API server to speed up your production application. -Features
-
+
- Implemented in TypeScript for strong type safety.
- Load OverpassQL scripts as strings into your JavaScript or TypeScript application.
- Optionally cache responses from an Overpass API server.
Features
Installation
You can install the loader using
npm,yarn, or your preferred JavaScript +Installation
You can install the loader using
-npm,yarn, or your preferred JavaScript package management program.
+yarn add --dev overpassql-loader -
+yarn add --dev overpassql-loader +or
-
-npm install --save-dev overpassql-loader -Usage
Add
-overpassql-loaderto your Webpack configuration:
+import type { Configuration, RuleSetUse } from 'webpack';
import type { PropertiesFilter } from 'overpassql-loader';
const IS_DEV: boolean = (process.env.NODE_ENV === 'development');
const propertiesFilter: PropertiesFilter = (properties) => ({
return (Object.keys(properties)
.filter(tag => /addr:.*/i.test(tag))
.reduce((filtered, tag) => {
filtered[tag] = properties[tag];
return filtered;
}, {}));
});
const useOverpassql: RuleSetUse = {
test: /\.overpass(ql)?$/,
options: {
// minify the query
stripWhitespace: !IS_DEV,
stripComments: !IS_DEV,
// cache API response
cacheGeoJSON: !IS_DEV,
// remove tags we're not interested in
keepProperties: false,
propertiesFilter
}
}
export const config: Configuration = {
module: {
rules: [useOverpassql]
}
} -
+ +npm install --save-dev overpassql-loader +Usage
Add
+overpassql-loaderto your Webpack configuration:
+import type { Configuration, RuleSetUse } from 'webpack';
import type { PropertiesFilter } from 'overpassql-loader';
const IS_DEV: boolean = (process.env.NODE_ENV === 'development');
const propertiesFilter: PropertiesFilter = (properties) => ({
return (Object.keys(properties)
.filter(tag => /addr:.*/i.test(tag))
.reduce((filtered, tag) => {
filtered[tag] = properties[tag];
return filtered;
}, {}));
});
const useOverpassql: RuleSetUse = {
test: /\.overpass(ql)?$/,
options: {
// minify the query
stripWhitespace: !IS_DEV,
stripComments: !IS_DEV,
// cache API response
cacheGeoJSON: !IS_DEV,
// remove tags we're not interested in
keepProperties: false,
propertiesFilter
}
}
export const config: Configuration = {
module: {
rules: [useOverpassql]
}
} +Use the
-importin your project:
-import { overpassJson } from 'overpass-ts';
import osmtogeojson from 'osmtogeojson';
import query from './my-query.overpassql';
const endpoint: string = 'https://overpass-api.de/api/interpreter';
console.log(query); // print the query to console
overpassJson(query, { endpoint }).then((osmdata) => {
const geoJSON = osmtogeojson(osmdata);
// work with the GeoJSON or OSM response
// e.g., integrate with Leaflet.js GeoJSON layers
}); -Contributing
General advice
The following procedure for contributing changes is recommended:
+
+ +import { overpassJson } from 'overpass-ts';
import osmtogeojson from 'osmtogeojson';
import query from './my-query.overpassql';
const endpoint: string = 'https://overpass-api.de/api/interpreter';
console.log(query); // print the query to console
overpassJson(query, { endpoint }).then((osmdata) => {
const geoJSON = osmtogeojson(osmdata);
// work with the GeoJSON or OSM response
// e.g., integrate with Leaflet.js GeoJSON layers
}); +Contributing
General advice
The following procedure for contributing changes is recommended:
- Branch to
fix/[issue or description],feature/[issue or description], ... - Implement your changes and commit
- Open a pull request
Of course, you're welcome to use any reasonable workflow that best suits your +
Of course, you're welcome to use any reasonable workflow that best suits your style. After all, I committed to unprotected main throughout this project.
Please add any of the following strings to your commit message if the commit does not modify any code (e.g., documentation work):
[skip ci],[ci skip],[no ci],[skip actions],[actions skip]See: GitHub documentation, "skipping workflow runs"
-Versioning
To bump versions:
-
-yarn version --patch
yarn version --minor
yarn version --major -Licensing
Given this project is licensed under the MIT License, please be mindful that +
Versioning
To bump versions:
+
+ +yarn version --patch
yarn version --minor
yarn version --major +Licensing
Given this project is licensed under the MIT License, please be mindful that your contributions will fall under the same licensing scheme.
-Related Projects & Dependencies
The following projects are core to the function of OverpassQL Loader. +
Related Projects & Dependencies
The following projects are core to the function of OverpassQL Loader. They are worth checking out. The authors have my thanks. :-)
-overpass-ts
+
overpass-ts
-promise-based overpass api client in typescript
osmtogeojson
+
osmtogeojson
-Converts OSM data to GeoJSON.
License
This project is licensed under the MIT License. +
License
This project is licensed under the MIT License. See
-LICENSEfor more information.loader | OverpassQL Loader \ No newline at end of file diff --git a/modules/properties.html b/modules/properties.html index 77c2d40..45728b7 100644 --- a/modules/properties.html +++ b/modules/properties.html @@ -1,5 +1,5 @@ -Module loader
Index
Type Aliases
Options +loader | OverpassQL Loader \ No newline at end of file +Module loader
Index
Type Aliases
Functions
properties | OverpassQL Loader \ No newline at end of file diff --git a/modules/syntax.html b/modules/syntax.html index 9598096..a010419 100644 --- a/modules/syntax.html +++ b/modules/syntax.html @@ -1,4 +1,4 @@ -Module properties
Index
Functions
defaultProperties Filter + properties | OverpassQL Loader \ No newline at end of file +Module properties
Index
Functions
syntax | OverpassQL Loader \ No newline at end of file diff --git a/types/loader.Options.html b/types/loader.Options.html index 2bcb3bf..8a58266 100644 --- a/types/loader.Options.html +++ b/types/loader.Options.html @@ -1,28 +1,28 @@ -Module syntax
Index
Variables
maxContent Size + syntax | OverpassQL Loader \ No newline at end of file +Module syntax
Index
Variables
Functions
Options | OverpassQL Loader \ No newline at end of file diff --git a/types/loader.PropertiesFilter.html b/types/loader.PropertiesFilter.html index 9892694..892b8b2 100644 --- a/types/loader.PropertiesFilter.html +++ b/types/loader.PropertiesFilter.html @@ -1 +1 @@ -Type alias Options
Options: {
cacheGeoJSON?: boolean;
esModule?: boolean;
keepProperties?: boolean;
osmtogeojsonOptions?: OsmToGeoJSONOptions;
overpassOptions?: Partial<OverpassOptions>;
propertiesFilter?: PropertiesFilter;
simplificationTolerance?: number;
stripComments?: boolean;
stripWhitespace?: boolean;
}OverpassQL Loader options.
-Type declaration
OptionalcacheGeoJSON?: boolean Preload and cache the Overpass API response from the query. +
Options | OverpassQL Loader \ No newline at end of file +Type Alias Options
Options: {
cacheGeoJSON?: boolean;
esModule?: boolean;
keepProperties?: boolean;
osmtogeojsonOptions?: OsmToGeoJSONOptions;
overpassOptions?: Partial<OverpassOptions>;
propertiesFilter?: PropertiesFilter;
simplificationTolerance?: number;
stripComments?: boolean;
stripWhitespace?: boolean;
}OverpassQL Loader options.
+Type declaration
OptionalcacheGeoJSON?: boolean Preload and cache the Overpass API response from the query. Connects to the Overpass API specified in
-endpointto execute the query and cache the GeoJSON response in the rendered module.OptionalesModule?: boolean Emit an ES-style module. -(e.g. 'export default' instead of 'module.exports =')
-OptionalkeepProperties?: boolean Avoid clobbering properties when caching the GeoJSON response from the +
OptionalesModule?: boolean Emit an ES-style module. +(e.g. 'export default' instead of 'module.exports =')
+OptionalkeepProperties?: boolean Avoid clobbering properties when caching the GeoJSON response from the Overpass API.
The value has no effect when
-cacheGeoJSONis not set or set to false.OptionalosmtogeojsonOptions?: OsmToGeoJSONOptions Options to pass through to the "osmtogeojson" package.
-See
"osmtogeojson" package: +
OptionalosmtogeojsonOptions?: OsmToGeoJSONOptions Options to pass through to the "osmtogeojson" package.
+See
"osmtogeojson" package: https://github.com/tyrasd/osmtogeojson https://www.npmjs.com/package/osmtogeojson
The value has no effect when
-cacheGeoJSONis not set or set to false.OptionaloverpassOptions?: Partial<OverpassOptions> Options to pass through to the Overpass API handler (e.g. "overpass-ts").
-See
"overpass-ts" package: +
OptionaloverpassOptions?: Partial<OverpassOptions> Options to pass through to the Overpass API handler (e.g. "overpass-ts").
+See
"overpass-ts" package: https://www.npmjs.com/package/overpass-ts
-OptionalpropertiesFilter?: PropertiesFilter Function to clobber properties (e.g. to remove or keep them).
+OptionalpropertiesFilter?: PropertiesFilter Function to clobber properties (e.g. to remove or keep them).
The value has no effect when
-cacheGeoJSONis not set or set to false. The value has no effect whenkeepPropertiesis set to true.OptionalsimplificationTolerance?: number Tolerance value for shape simplification. +
OptionalsimplificationTolerance?: number Tolerance value for shape simplification. Function uses the "simplify-geojson" package: https://www.npmjs.com/package/simplify-geojson https://github.com/maxogden/simplify-geojson
-OptionalstripComments?: boolean Remove comments to save space. +
OptionalstripComments?: boolean Remove comments to save space. The function to strip comments will respect "@preserve" directives.
-OptionalstripWhitespace?: boolean Remove redundant whitespace to save space.
-
OptionalstripWhitespace?: boolean Remove redundant whitespace to save space.
+
PropertiesFilter | OverpassQL Loader \ No newline at end of file +Type alias PropertiesFilter
PropertiesFilter: ((properties) => GeoJsonProperties) Type declaration
- (properties): GeoJsonProperties
Parameters
- properties: GeoJsonProperties
Returns GeoJsonProperties
PropertiesFilter | OverpassQL Loader \ No newline at end of file diff --git a/variables/syntax.maxContentSize.html b/variables/syntax.maxContentSize.html index f8d737f..b314eec 100644 --- a/variables/syntax.maxContentSize.html +++ b/variables/syntax.maxContentSize.html @@ -1,3 +1,3 @@ -Type Alias PropertiesFilter
PropertiesFilter: ((properties: GeoJsonProperties) => GeoJsonProperties) maxContentSize | OverpassQL Loader \ No newline at end of fileVariable maxContentSize
ConstmaxContent Size: number = 100000000 Maximum permissible content size, measured in number of characters, to +
maxContentSize | OverpassQL Loader \ No newline at end of file +Variable maxContentSize
ConstmaxContent Size: number = 100000000 Maximum permissible content size, measured in number of characters, to prevent occurrences of ReDoS (Regular expression Denial of Service).
- - process
- is
- properties: GeoJsonProperties
API function for Overpass JSON responses. +
- Preparing search index...
- The search index is not available
OverpassQL LoaderFunction api
API function for Overpass JSON responses. Useful if you want to implement your own way of doing it. :-)
-Parameters
Optionalopts: Partial<OverpassOptions>Returns Promise<OverpassJson>
Settings
Member Visibility
Theme