diff --git a/functions/loader.api.html b/functions/loader.api.html index 3c2537f..f56b257 100644 --- a/functions/loader.api.html +++ b/functions/loader.api.html @@ -1,3 +1,3 @@ api | OverpassQL Loader

Function api

  • api(query, opts?): Promise<OverpassJson>

  • API function for Overpass JSON responses. Useful if you want to implement your own way of doing it. :-)

    -

    Parameters

    • query: string
    • Optional opts: Partial<OverpassOptions>

    Returns Promise<OverpassJson>

Settings

Member Visibility

Theme

\ No newline at end of file +

Parameters

Returns Promise<OverpassJson>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/loader.loader.html b/functions/loader.loader.html index 92f1751..7761a0f 100644 --- a/functions/loader.loader.html +++ b/functions/loader.loader.html @@ -5,4 +5,4 @@ loadable JavaScript module, optionally with minification and precached GeoJSON results.

Throws

when this (loader context) is not provided

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/properties.defaultPropertiesFilter.html b/functions/properties.defaultPropertiesFilter.html index 86bae8e..4b5a702 100644 --- a/functions/properties.defaultPropertiesFilter.html +++ b/functions/properties.defaultPropertiesFilter.html @@ -2,4 +2,4 @@ This removes everything but names and addresses.

Parameters

Returns GeoJsonProperties

Properties with tags other than name and address removed

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/properties.hasProperties.html b/functions/properties.hasProperties.html index 2148d65..7ad55e0 100644 --- a/functions/properties.hasProperties.html +++ b/functions/properties.hasProperties.html @@ -2,4 +2,4 @@ GeoJSON properties.

Parameters

Returns boolean

True when the object contains properties

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/properties.isTraversible.html b/functions/properties.isTraversible.html index d2f4b43..ca71718 100644 --- a/functions/properties.isTraversible.html +++ b/functions/properties.isTraversible.html @@ -2,4 +2,4 @@ key-value object, e.g., GeoJSON.

Parameters

Returns boolean

True when the object is traversible

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/properties.processProperties.html b/functions/properties.processProperties.html index 6678722..4581f16 100644 --- a/functions/properties.processProperties.html +++ b/functions/properties.processProperties.html @@ -3,4 +3,4 @@

Parameters

Returns GeoJsonProperties

OpenStreetMaps GeoJSON object after filtering with the function

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/syntax.stripComments.html b/functions/syntax.stripComments.html index 6a6bb42..da081b0 100644 --- a/functions/syntax.stripComments.html +++ b/functions/syntax.stripComments.html @@ -1,4 +1,4 @@ stripComments | OverpassQL Loader

Function stripComments

  • stripComments(content): string

  • Remove comments from an OverpassQL string.

    Parameters

    • content: string

      OverpassQL content string

    Returns string

    OverpassQL content string with comments removed

    -

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/syntax.stripWhitespace.html b/functions/syntax.stripWhitespace.html index 98a40b8..e1cab9d 100644 --- a/functions/syntax.stripWhitespace.html +++ b/functions/syntax.stripWhitespace.html @@ -1,4 +1,4 @@ stripWhitespace | OverpassQL Loader

Function stripWhitespace

  • stripWhitespace(content): string

  • Remove whitespace from an OverpassQL string while preserving comments.

    Parameters

    • content: string

      OverpassQL content string

    Returns string

    OverpassQL content string with extra whitespace removed

    -

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/modules/loader.html b/modules/loader.html index 320c5d4..a7f42fd 100644 --- a/modules/loader.html +++ b/modules/loader.html @@ -1,4 +1,4 @@ -loader | OverpassQL Loader

Module loader

Index

Type Aliases

Options +loader | OverpassQL Loader

Module loader

Index

Type Aliases

Options PropertiesFilter

Functions

api loader diff --git a/modules/properties.html b/modules/properties.html index d95f1ed..972ac57 100644 --- a/modules/properties.html +++ b/modules/properties.html @@ -1,4 +1,4 @@ -properties | OverpassQL Loader

Module properties

Index

Functions

defaultPropertiesFilter +properties | OverpassQL Loader

Module properties

Index

Functions

defaultPropertiesFilter hasProperties isTraversible processProperties diff --git a/modules/syntax.html b/modules/syntax.html index 3395557..3576b1f 100644 --- a/modules/syntax.html +++ b/modules/syntax.html @@ -1,4 +1,4 @@ -syntax | OverpassQL Loader

Module syntax

Index

Variables

maxContentSize +syntax | OverpassQL Loader

Module syntax

Index

Variables

maxContentSize

Functions

stripComments stripWhitespace

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/loader.Options.html b/types/loader.Options.html index d4bbc4c..2bea8d9 100644 --- a/types/loader.Options.html +++ b/types/loader.Options.html @@ -25,4 +25,4 @@
  • Optional stripComments?: boolean

    Remove comments to save space. The function to strip comments will respect "@preserve" directives.

  • Optional stripWhitespace?: boolean

    Remove redundant whitespace to save space.

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/loader.PropertiesFilter.html b/types/loader.PropertiesFilter.html index b8c8ee4..a7d6761 100644 --- a/types/loader.PropertiesFilter.html +++ b/types/loader.PropertiesFilter.html @@ -1 +1 @@ -PropertiesFilter | OverpassQL Loader

    Type alias PropertiesFilter

    PropertiesFilter: ((properties) => GeoJsonProperties)

    Type declaration

      • (properties): GeoJsonProperties

      • Parameters

        • properties: GeoJsonProperties

        Returns GeoJsonProperties

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +PropertiesFilter | OverpassQL Loader

    Type alias PropertiesFilter

    PropertiesFilter: ((properties) => GeoJsonProperties)

    Type declaration

      • (properties): GeoJsonProperties

      • Parameters

        • properties: GeoJsonProperties

        Returns GeoJsonProperties

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/variables/syntax.maxContentSize.html b/variables/syntax.maxContentSize.html index 15d9e01..8cfa9d6 100644 --- a/variables/syntax.maxContentSize.html +++ b/variables/syntax.maxContentSize.html @@ -1,3 +1,3 @@ maxContentSize | OverpassQL Loader

    Variable maxContentSizeConst

    maxContentSize: number = 100000000

    Maximum permissible content size, measured in number of characters, to prevent occurrences of ReDoS (Regular expression Denial of Service).

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file