Skip to content

Commit

Permalink
Generated documentations
Browse files Browse the repository at this point in the history
  • Loading branch information
QSmally committed Nov 21, 2020
1 parent 7378a99 commit d458571
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 18 deletions.
18 changes: 9 additions & 9 deletions Documentation/Connection.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ const Users = new QDB.Connection("lib/Databases/Users.qdb");
>
> Returns **{Selection}** A Selection class instance.
## [.Push(KeyOrPath, Values)](https://github.com/QSmally/QDB/blob/v4/lib/Connections/Connection.js#L502)
## [.Push(KeyOrPath, Values)](https://github.com/QSmally/QDB/blob/v4/lib/Connections/Connection.js#L505)
> Pushes something to an array at the path output.
> | Key | Type | Description |
> | --- | --- | --- |
Expand All @@ -170,7 +170,7 @@ const Users = new QDB.Connection("lib/Databases/Users.qdb");
>
> Returns **{Number}** New length of the array.
## [.Shift(KeyOrPath, Values?)](https://github.com/QSmally/QDB/blob/v4/lib/Connections/Connection.js#L521)
## [.Shift(KeyOrPath, Values?)](https://github.com/QSmally/QDB/blob/v4/lib/Connections/Connection.js#L524)
> Inserts (if defined) or removes a value to/from the front of the array.
> | Key | Type | Description |
> | --- | --- | --- |
Expand All @@ -179,15 +179,15 @@ const Users = new QDB.Connection("lib/Databases/Users.qdb");
>
> Returns **{Number|Any}** New length of the array if a value was inserted, or the shifted value.
## [.Pop(KeyOrPath)](https://github.com/QSmally/QDB/blob/v4/lib/Connections/Connection.js#L544)
## [.Pop(KeyOrPath)](https://github.com/QSmally/QDB/blob/v4/lib/Connections/Connection.js#L547)
> Pops something from an array at the path output.
> | Key | Type | Description |
> | --- | --- | --- |
> | KeyOrPath | Pathlike | Specifies which row or nested array to pop from. |
>
> Returns **{Any}** Returns the popped value.
## [.Remove(KeyOrPath, Fn)](https://github.com/QSmally/QDB/blob/v4/lib/Connections/Connection.js#L561)
## [.Remove(KeyOrPath, Fn)](https://github.com/QSmally/QDB/blob/v4/lib/Connections/Connection.js#L564)
> Removes a specific element from this endpoint array.
> | Key | Type | Description |
> | --- | --- | --- |
Expand All @@ -196,7 +196,7 @@ const Users = new QDB.Connection("lib/Databases/Users.qdb");
>
> Returns **{Number}** New length of the array.
## [.Ensure(KeyOrPath, Input, Merge?)](https://github.com/QSmally/QDB/blob/v4/lib/Connections/Connection.js#L588)
## [.Ensure(KeyOrPath, Input, Merge?)](https://github.com/QSmally/QDB/blob/v4/lib/Connections/Connection.js#L591)
> Inserts an input into a row or nested object if the key or path wasn't found at the endpoint. It can be used as a default schema of the database elements, that gets inserted if there's no entry already.
> | Key | Type | Description |
> | --- | --- | --- |
Expand All @@ -206,7 +206,7 @@ const Users = new QDB.Connection("lib/Databases/Users.qdb");
>
> Returns **{Boolean}** Whether or not the new value was inserted.
## [.Modify(KeyOrPath, Fn)](https://github.com/QSmally/QDB/blob/v4/lib/Connections/Connection.js#L614)
## [.Modify(KeyOrPath, Fn)](https://github.com/QSmally/QDB/blob/v4/lib/Connections/Connection.js#L617)
> Updates a value in the database by fetching it and passing it onto the callback function.
> | Key | Type | Description |
> | --- | --- | --- |
Expand All @@ -215,7 +215,7 @@ const Users = new QDB.Connection("lib/Databases/Users.qdb");
>
> Returns **{Object|Array|DataModel}** Returns the new row of the updated property.
## [.Invert(KeyOrPath)](https://github.com/QSmally/QDB/blob/v4/lib/Connections/Connection.js#L632)
## [.Invert(KeyOrPath)](https://github.com/QSmally/QDB/blob/v4/lib/Connections/Connection.js#L635)
> Inverts a boolean, from true to false and vice-versa, at the endpoint of the path.
> | Key | Type | Description |
> | --- | --- | --- |
Expand All @@ -224,7 +224,7 @@ const Users = new QDB.Connection("lib/Databases/Users.qdb");
> Returns **{Boolean}** Returns the updated boolean value of the property.
# Typedefs
## [RawOptions](https://github.com/QSmally/QDB/blob/v4/lib/Connections/Connection.js#L653)
## [RawOptions](https://github.com/QSmally/QDB/blob/v4/lib/Connections/Connection.js#L656)
> Options for a database Connection. All integer related options are in milliseconds.
> | Key | Type | Description |
> | --- | --- | --- |
Expand All @@ -244,7 +244,7 @@ const Users = new QDB.Connection("lib/Databases/Users.qdb");
>
> Type **{Object}**
## [DataModel](https://github.com/QSmally/QDB/blob/v4/lib/Connections/Connection.js#L676)
## [DataModel](https://github.com/QSmally/QDB/blob/v4/lib/Connections/Connection.js#L679)
> An entry which has been resolved from the Connection's internal cache.
> | Key | Type | Description |
> | --- | --- | --- |
Expand Down
18 changes: 9 additions & 9 deletions Documentation/Output.json
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@
{
"Value": "Push",
"Flags": [],
"Line": 502,
"Line": 505,
"Description": "Pushes something to an array at the path output.",
"Params": [
"{Pathlike} KeyOrPath Specifies which row or nested array to push to.",
Expand All @@ -300,7 +300,7 @@
{
"Value": "Shift",
"Flags": [],
"Line": 521,
"Line": 524,
"Description": "Inserts (if defined) or removes a value to/from the front of the array.",
"Params": [
"{Pathlike} KeyOrPath Specifies which row or nested array to insert to/remove from.",
Expand All @@ -311,7 +311,7 @@
{
"Value": "Pop",
"Flags": [],
"Line": 544,
"Line": 547,
"Description": "Pops something from an array at the path output.",
"Params": [
"{Pathlike} KeyOrPath Specifies which row or nested array to pop from."
Expand All @@ -321,7 +321,7 @@
{
"Value": "Remove",
"Flags": [],
"Line": 561,
"Line": 564,
"Description": "Removes a specific element from this endpoint array.",
"Params": [
"{Pathlike} KeyOrPath Specifies which row or nested array to remove a value from.",
Expand All @@ -332,7 +332,7 @@
{
"Value": "Ensure",
"Flags": [],
"Line": 588,
"Line": 591,
"Description": "Inserts an input into a row or nested object if the key or path wasn't found at the endpoint. It can be used as a default schema of the database elements, that gets inserted if there's no entry already.",
"Params": [
"{Pathlike} KeyOrPath Context key to see if it exists, either a row or nested property, and optionally insert the new value.",
Expand All @@ -344,7 +344,7 @@
{
"Value": "Modify",
"Flags": [],
"Line": 614,
"Line": 617,
"Description": "Updates a value in the database by fetching it and passing it onto the callback function.",
"Params": [
"{Pathlike} KeyOrPath Specifies which row or nested property to fetch.",
Expand All @@ -355,7 +355,7 @@
{
"Value": "Invert",
"Flags": [],
"Line": 632,
"Line": 635,
"Description": "Inverts a boolean, from true to false and vice-versa, at the endpoint of the path.",
"Params": [
"{Pathlike} KeyOrPath Specifies which row or nested property to boolean-invert."
Expand All @@ -367,7 +367,7 @@
"Flags": [
"Typedef"
],
"Line": 653,
"Line": 656,
"Description": "Options for a database Connection. All integer related options are in milliseconds. ",
"Typedef": "{Object} RawOptions",
"Params": [
Expand All @@ -391,7 +391,7 @@
"Flags": [
"Typedef"
],
"Line": 676,
"Line": 679,
"Description": "An entry which has been resolved from the Connection's internal cache.",
"Typedef": "{Object|Array} DataModel",
"Params": [
Expand Down

0 comments on commit d458571

Please sign in to comment.