midgard/MapComplete
1
0
Fork 0
forked from MapComplete/MapComplete
Code Pull requests Activity

Add docs on URL-parameters

Browse source
This commit is contained in:
Pieter Vander Vennet 2021-04-06 18:34:45 +02:00
parent 4d5c250f8f
commit 454f30cf3b
3 changed files with 120 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

12
Logic/Web/QueryParameters.ts
View file

@ -38,6 +38,10 @@ export class QueryParameters {
QueryParameters.knownSources[key] = source;
}
}
window["mapcomplete_query_parameter_overview"] = () => {
console.log(QueryParameters.GenerateQueryParameterDocs())
}
}
private static Serialize() {
@ -84,7 +88,13 @@ export class QueryParameters {
public static GenerateQueryParameterDocs(): string {
const docs = [];
for (const key in QueryParameters.documentation) {
docs.push("**" + key + "**: " + QueryParameters.documentation[key] + " (default value: _" + QueryParameters.defaults[key] + "_)")
docs.push([
" "+key+" ",
"-".repeat(key.length + 2),
QueryParameters.documentation[key],
QueryParameters.defaults[key] === undefined ? "No default value set" : `The default value is _${QueryParameters.defaults[key]}_`
].join("\n"))
}
return docs.join("\n\n");
}