mirror of https://github.com/Hax-io/libpb
Updated usage examples with record management and updated assertions
This commit is contained in:
parent
0cd17f976e
commit
b894b6e1c6
113
README.md
113
README.md
|
@ -20,30 +20,37 @@ PocketBase pb = new PocketBase("http://127.0.0.1:8090/api/");
|
||||||
This is just to show off the serialization method `serializeRecord(RecordType)` which returns a `JSONValue` struct:
|
This is just to show off the serialization method `serializeRecord(RecordType)` which returns a `JSONValue` struct:
|
||||||
|
|
||||||
```d
|
```d
|
||||||
import std.algorithm.searching : canFind;
|
import std.algorithm.searching : canFind;
|
||||||
import std.string : cmp;
|
import std.string : cmp;
|
||||||
|
|
||||||
struct Person
|
|
||||||
{
|
|
||||||
public string firstname, lastname;
|
|
||||||
public int age;
|
|
||||||
public string[] list;
|
|
||||||
public JSONValue extraJSON;
|
|
||||||
}
|
|
||||||
|
|
||||||
Person p1;
|
struct Person
|
||||||
p1.firstname = "Tristan";
|
{
|
||||||
p1.lastname = "Kildaire";
|
public string firstname, lastname;
|
||||||
p1.age = 23;
|
public int age;
|
||||||
p1.list = ["1", "2", "3"];
|
public string[] list;
|
||||||
p1.extraJSON = parseJSON(`{"item":1, "items":[1,2,3]}`);
|
public JSONValue extraJSON;
|
||||||
|
public EnumType eType;
|
||||||
|
}
|
||||||
|
|
||||||
JSONValue serialized = PocketBase.serializeRecord(p1);
|
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]}`);
|
||||||
|
p1.eType = EnumType.CAT;
|
||||||
|
|
||||||
string[] keys = serialized.object().keys();
|
JSONValue serialized = PocketBase.serializeRecord(p1);
|
||||||
assert(canFind(keys, "firstname") && cmp(serialized["firstname"].str(), "Tristan") == 0);
|
|
||||||
assert(canFind(keys, "lastname") && cmp(serialized["lastname"].str(), "Kildaire") == 0);
|
string[] keys = serialized.object().keys();
|
||||||
assert(canFind(keys, "age") && serialized["age"].integer() == 23);
|
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);
|
||||||
|
|
||||||
|
debug(dbg)
|
||||||
|
{
|
||||||
|
writeln(serialized.toPrettyString());
|
||||||
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Deserialization
|
### Deserialization
|
||||||
|
@ -51,18 +58,18 @@ This is just to show off the serialization method `serializeRecord(RecordType)`
|
||||||
This is to show off deserialization method `fromJSON(RecordType)(JSONValue jsonIn)` which returns a struct of type `RecordType` (so far most features are implemented):
|
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
|
```d
|
||||||
import std.string : cmp;
|
import std.string : cmp;
|
||||||
|
|
||||||
struct Person
|
struct Person
|
||||||
{
|
{
|
||||||
public string firstname, lastname;
|
public string firstname, lastname;
|
||||||
public int age;
|
public int age;
|
||||||
public bool isMale;
|
public bool isMale;
|
||||||
public JSONValue obj;
|
public JSONValue obj;
|
||||||
public int[] list;
|
public int[] list;
|
||||||
}
|
}
|
||||||
|
|
||||||
JSONValue json = parseJSON(`{
|
JSONValue json = parseJSON(`{
|
||||||
"firstname" : "Tristan",
|
"firstname" : "Tristan",
|
||||||
"lastname": "Kildaire",
|
"lastname": "Kildaire",
|
||||||
"age": 23,
|
"age": 23,
|
||||||
|
@ -72,15 +79,45 @@ This is to show off deserialization method `fromJSON(RecordType)(JSONValue jsonI
|
||||||
}
|
}
|
||||||
`);
|
`);
|
||||||
|
|
||||||
Person person = PocketBase.fromJSON!(Person)(json);
|
Person person = PocketBase.fromJSON!(Person)(json);
|
||||||
|
|
||||||
writeln(person);
|
debug(dbg)
|
||||||
|
{
|
||||||
|
writeln(person);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
assert(cmp(person.firstname, "Tristan") == 0);
|
assert(cmp(person.firstname, "Tristan") == 0);
|
||||||
assert(cmp(person.lastname, "Kildaire") == 0);
|
assert(cmp(person.lastname, "Kildaire") == 0);
|
||||||
assert(person.age == 23);
|
assert(person.age == 23);
|
||||||
assert(person.isMale == true);
|
assert(person.isMale == true);
|
||||||
//TODO: object test case, list test case
|
assert(person.obj["bruh"].integer() == 1);
|
||||||
|
//TODO: list test case
|
||||||
|
```
|
||||||
|
|
||||||
|
### Record management
|
||||||
|
|
||||||
|
Below we have a few calls like create and delete:
|
||||||
|
|
||||||
|
```d
|
||||||
|
PocketBase pb = new PocketBase();
|
||||||
|
|
||||||
|
struct Person
|
||||||
|
{
|
||||||
|
string id;
|
||||||
|
string name;
|
||||||
|
int age;
|
||||||
|
}
|
||||||
|
|
||||||
|
Person p1 = Person();
|
||||||
|
p1.name = "Tristan Gonzales";
|
||||||
|
p1.age = 23;
|
||||||
|
|
||||||
|
Person recordStored = pb.createRecord("dummy", p1);
|
||||||
|
pb.deleteRecord("dummy", recordStored.id);
|
||||||
|
|
||||||
|
recordStored = pb.createRecord("dummy", p1);
|
||||||
|
pb.deleteRecord("dummy", recordStored);
|
||||||
```
|
```
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
Loading…
Reference in New Issue