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

49 lines
1.2 KiB
Markdown

# @digitransit-search-util/digitransit-search-util-serialize
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
## serialize
Serializes objects
### Parameters
- `obj` **[Object][1]** Object to be serialized
- `prefix` **Any**
### Examples
```javascript
digitransit-search-util.serialize(param1, param2);
//=true
```
Returns **[String][2]** Serialized object
[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
<!-- 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-serialize
```
Or install the Digitransit-util module that includes it as a function:
```sh
$ npm install @digitransit-util/digitransit-util
```