status-im
/
nim-graphql
mirror of https://github.com/status-im/nim-graphql.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

update documentation about response stream changes

This commit is contained in:
jangko 2021-04-12 15:54:23 +07:00
parent d94d796b04
commit fe77fb5362
No known key found for this signature in database
GPG Key ID: 31702AE10541E6B9
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/api.md
View File

@ -53,9 +53,10 @@ If you find anything not listed or not exported in this list, please submit an i
- `resp(x: float64): Node` - `resp(x: float64): Node`
#### Builtin JSON response stream API #### Builtin JSON response stream API
- `newJsonRespStream(doubleEscape = false): RespStream`. Create a new JSON response stream object. - `new(_: type JsonRespStream, doubleEscape = false): RespStream`. Create a new JSON response stream object.
When `doubleEscape` is true, the `getOutput` will return a text string that can be embedded in a json string. When `doubleEscape` is true, the `getOutput` will return a text string that can be embedded in a json string.
- `getOutput(): string`. Get a string output from response stream. - `getOutput(): string`. Get a string output from response stream.
- `JsonRespStream`. The JSON stream type
#### Datatypes #### Datatypes
- `ErrorDesc`. - `ErrorDesc`.