@workerbase/sdk
Advanced tools
Comparing version 0.1.25 to 0.1.26
{ | ||
"name": "@workerbase/sdk", | ||
"version": "0.1.25", | ||
"version": "0.1.26", | ||
"description": "", | ||
@@ -5,0 +5,0 @@ "scripts": { |
@@ -254,3 +254,3 @@ # Workerbase SDK for JavaScript | ||
## Database Items Query documentation | ||
## Database Items Query | ||
@@ -265,8 +265,8 @@ ### Getting started | ||
**`Employee` database** | ||
| Column | ID | **Name** | **Email** | **Birthday** | **Department** | **Office** | | ||
| ------ | -------- | -------------- | ------------------ | ------------ | --------------------------- | ------------------------ | | ||
| Type | _String_ | _String_ | _String_ | _Date_ | _Reference<br>[Department]_ | _Location_ | | ||
| | 1 | Vannie Doulden | vannie@company.com | 12.11.1988 | 1 | North America / New York | | ||
| | 2 | Marijo Stede | marijo@company.com | 03.06.1994 | 2 | Europe / Munich | | ||
| | 3 | Jade Plante | jade@company.com | 27.02.1990 | 2 | Europe / Munich | | ||
| ID | **Name** | **Email** | **Birthday** | **Department** | **Office** | | ||
| -------- | -------------- | ------------------ | ------------ | --------------------------- | ------------------------ | | ||
| _String_ | _String_ | _String_ | _Date_ | _Reference<br>[Department]_ | _Location_ | | ||
| 1 | Vannie Doulden | vannie@company.com | 12.11.1988 | 1 | North America / New York | | ||
| 2 | Marijo Stede | marijo@company.com | 03.06.1994 | 2 | Europe / Munich | | ||
| 3 | Jade Plante | jade@company.com | 27.02.1990 | 2 | Europe / Munich | | ||
@@ -287,3 +287,3 @@ All employees where the birthday is after the `01.01.1989` and the name ends on `Stede` should be queried. | ||
The variable `result` will contain the employee `Marijo Stede`. | ||
The `result` variable will contain the employee `Marijo Stede`. | ||
@@ -314,3 +314,3 @@ ```JSON | ||
Before looking into advanced features we reccoment to review the [Typings Definition](#typings-definition) of the query function. | ||
Before looking into advanced features we recomment to review the [Typings Definition](#typings-definition) of the query function. | ||
@@ -473,18 +473,18 @@ ### Typings Definition | ||
Example: The Department column of the `Employee` database is of type `Reference` and points to the database `Department`. Also the `Employee` database has a column `Office` which is of type `Location` and points to locations in the Workerbase platform. | ||
Example: The Department column of the `Employee` database is of type `Reference` and points to the database `Department`. Furthermore the `Employee` database has a column `Office` which is of type `Location` and points to locations in the Workerbase platform. | ||
**`Employee` database** | ||
| Column | ID | **Name** | **Email** | **Birthday** | **Department** | **Office** | | ||
|--------|----------|----------------|--------------------|--------------|-------------------------|------------| | ||
| Type | _String_ | _String_ | _String_ | _Date_ | _Reference<br>[Department]_ | _Location_ | | ||
| | 1 | Vannie Doulden | vannie@company.com | 12.11.1988 | 1 | North America / New York | | ||
| | 2 | Marijo Stede | marijo@company.com | 03.06.1994 | 2 | Europe / Munich | | ||
| | 3 | Jade Plante | jade@company.com | 27.02.1990 | 2 | Europe / Munich | | ||
| ID | **Name** | **Email** | **Birthday** | **Department** | **Office** | | ||
|----------|----------------|--------------------|--------------|-------------------------|------------| | ||
| _String_ | _String_ | _String_ | _Date_ | _Reference<br>[Department]_ | _Location_ | | ||
| 1 | Vannie Doulden | vannie@company.com | 12.11.1988 | 1 | North America / New York | | ||
| 2 | Marijo Stede | marijo@company.com | 03.06.1994 | 2 | Europe / Munich | | ||
| 3 | Jade Plante | jade@company.com | 27.02.1990 | 2 | Europe / Munich | | ||
**`Department` database** | ||
| Column | ID | **Name** | **Headcount** | | ||
|--------|----------|--------------------|---------------| | ||
| Type | _String_ | _String_ | _Number_ | | ||
| | 1 | Product Management | 10 | | ||
| | 2 | Engineering | 25 | | ||
| ID | **Name** | **Headcount** | | ||
|----------|--------------------|---------------| | ||
| _String_ | _String_ | _Number_ | | ||
| 1 | Product Management | 10 | | ||
| 2 | Engineering | 25 | | ||
@@ -542,5 +542,5 @@ The employee `Vannie Doulden` is queried with the `{ populate: true }` option, which includes the references `Department` and `Location` as objects into the result. | ||
In order to filter on references of items, nested property queries have to be added to the `query` parameter. Nested properties are specified by adding `$` in the beginning and end of a path i.e. `$Office.Name$`. | ||
In order to filter on references of items, conditions on nested properties have to be added to the `query` parameter. Nested properties are specified by adding `$` in the beginning and end of a path i.e. `$Office.Name$`. | ||
> Please keep in mind that the nested property queries can only be used when `{ populate: true }` is added to the `options` parameter. | ||
> Please keep in mind that nested property queries can only be used when `{ populate: true }` is added to the `options` parameter. | ||
@@ -547,0 +547,0 @@ Example: All employees whose `Department` has a `Headcount` less than `20` should be queried. |
110920