mirror of https://github.com/Hax-io/libpb
- Added example usage of serialization/deserialization to README
- Changed targetType in dub.json to library
This commit is contained in:
parent
3c6a81791b
commit
0c4eecaad3
78
README.md
78
README.md
|
@ -7,7 +7,83 @@ libpb
|
||||||
|
|
||||||
## Example usage
|
## Example usage
|
||||||
|
|
||||||
TODO
|
|
||||||
|
### Server initiation
|
||||||
|
|
||||||
|
Firstly we create a new PocketBase instance to manage our server:
|
||||||
|
|
||||||
|
```d
|
||||||
|
PocketBase pb = new PocketBase("http://127.0.0.1:8090/api/");
|
||||||
|
```
|
||||||
|
|
||||||
|
### Serialization
|
||||||
|
|
||||||
|
This is just to show off the serialization method `serializeRecord(RecordType)` which returns a `JSONValue` struct:
|
||||||
|
|
||||||
|
```d
|
||||||
|
import std.algorithm.searching : canFind;
|
||||||
|
import std.string : cmp;
|
||||||
|
|
||||||
|
struct Person
|
||||||
|
{
|
||||||
|
public string firstname, lastname;
|
||||||
|
public int age;
|
||||||
|
public string[] list;
|
||||||
|
public JSONValue extraJSON;
|
||||||
|
}
|
||||||
|
|
||||||
|
Person p1;
|
||||||
|
p1.firstname = "Tristan";
|
||||||
|
p1.lastname = "Kildaire";
|
||||||
|
p1.age = 23;
|
||||||
|
p1.list = ["1", "2", "3"];
|
||||||
|
p1.extraJSON = parseJSON(`{"item":1, "items":[1,2,3]}`);
|
||||||
|
|
||||||
|
JSONValue serialized = PocketBase.serializeRecord(p1);
|
||||||
|
|
||||||
|
string[] keys = serialized.object().keys();
|
||||||
|
assert(canFind(keys, "firstname") && cmp(serialized["firstname"].str(), "Tristan") == 0);
|
||||||
|
assert(canFind(keys, "lastname") && cmp(serialized["lastname"].str(), "Kildaire") == 0);
|
||||||
|
assert(canFind(keys, "age") && serialized["age"].integer() == 23);
|
||||||
|
```
|
||||||
|
|
||||||
|
### Deserialization
|
||||||
|
|
||||||
|
This is to show off deserialization method `fromJSON(RecordType)(JSONValue jsonIn)` which returns a struct of type `RecordType` (so far most features are implemented):
|
||||||
|
|
||||||
|
```d
|
||||||
|
import std.string : cmp;
|
||||||
|
|
||||||
|
struct Person
|
||||||
|
{
|
||||||
|
public string firstname, lastname;
|
||||||
|
public int age;
|
||||||
|
public bool isMale;
|
||||||
|
public JSONValue obj;
|
||||||
|
public int[] list;
|
||||||
|
}
|
||||||
|
|
||||||
|
JSONValue json = parseJSON(`{
|
||||||
|
"firstname" : "Tristan",
|
||||||
|
"lastname": "Kildaire",
|
||||||
|
"age": 23,
|
||||||
|
"obj" : {"bruh":1},
|
||||||
|
"isMale": true,
|
||||||
|
"list": [1,2,3]
|
||||||
|
}
|
||||||
|
`);
|
||||||
|
|
||||||
|
Person person = PocketBase.fromJSON!(Person)(json);
|
||||||
|
|
||||||
|
writeln(person);
|
||||||
|
|
||||||
|
assert(cmp(person.firstname, "Tristan") == 0);
|
||||||
|
assert(cmp(person.lastname, "Kildaire") == 0);
|
||||||
|
assert(person.age == 23);
|
||||||
|
assert(person.isMale == true);
|
||||||
|
//TODO: object test case, list test case
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|
5
dub.json
5
dub.json
|
@ -5,5 +5,6 @@
|
||||||
"copyright": "Copyright © 2022, Tristan B. Velloza Kildaire",
|
"copyright": "Copyright © 2022, Tristan B. Velloza Kildaire",
|
||||||
"description": "PocketBase wrapper with serializer/deserializer support",
|
"description": "PocketBase wrapper with serializer/deserializer support",
|
||||||
"license": "LGPL v3.0",
|
"license": "LGPL v3.0",
|
||||||
"name": "libpb"
|
"name": "libpb",
|
||||||
}
|
"targetType" : "library"
|
||||||
|
}
|
||||||
|
|
Loading…
Reference in New Issue