digitransit-ui/digitransit-search-util/packages/digitransit-search-util-get-json/README.md
Janne Antikainen ff6c0c536a feat: readMes
2020-04-22 12:20:03 +03:00

51 lines
1.3 KiB
Markdown

# @digitransit-search-util/digitransit-search-util-get-json
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
## getJson
Return Promise for a url json get request
### Parameters
- `url` **[String][1]**
- `params` **[Array][2]**
### Examples
```javascript
digitransit-search-util.getJson(param1, param2);
//=response
```
Returns **[Object][3]** response
[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
<!-- This file is automatically generated. Please don't edit it directly:
if you find an error, edit the source file (likely index.js), and re-run
./scripts/generate-readmes in the digitransit-util project. -->
---
This module is part of the Digitransit-ui project. It is maintained in the
[HSLdevcom/digitransit-ui](https://github.com/HSLdevcom/digitransit-ui) repository, where you can create
PRs and issues.
### Installation
Install this module individually:
```sh
$ npm install @digitransit-search-util/digitransit-search-util-get-json
```
Or install the Digitransit-util module that includes it as a function:
```sh
$ npm install @digitransit-util/digitransit-util
```