aboutsummaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorAndrew Harvey <andrew@alantgeo.com.au>2021-06-09 15:30:39 +1000
committerAndrew Harvey <andrew@alantgeo.com.au>2021-06-09 15:30:39 +1000
commit5baa1376a1b44bb7a57b31513f45a9a30da869fd (patch)
tree314df178850786bc8acc2b1dc824abf0fb32e9fc /lib
parent567e07d9a8f10f098bdb948374c32e96acf96a47 (diff)
jsdoc toOSM
Diffstat (limited to 'lib')
-rw-r--r--lib/toOSM.js4
1 files changed, 4 insertions, 0 deletions
diff --git a/lib/toOSM.js b/lib/toOSM.js
index 3e57c3f..e96568c 100644
--- a/lib/toOSM.js
+++ b/lib/toOSM.js
@@ -14,6 +14,10 @@ const emptyNames = [
* Transforms a GeoJSON Feature from the Vicmap address schema into OSM schema
*
* @param {Array} sourceFeature Feature in Vicmap address schema
+ * @param {Object} [options]
+ * @param {string} [options.tracing=false]
+ * @param {string} [options.includeUnitPrefix=false] include addr:unit:prefix to indicate unit type (UNIT, SHOP, SUITE, FLAT, etc.)
+ * @param {string} [options.includeDerivableProperties=false] include properties addr:suburb, addr:postcode, addr:state which can be derived from existing boundaries on each address object
* @returns {Object} Feature in OSM schema
*/
module.exports = (sourceFeature, options) => {