Skip to content

Commit

Permalink
Generated documentations
Browse files Browse the repository at this point in the history
  • Loading branch information
QSmally committed Oct 25, 2020
1 parent 013531c commit 3692899
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions Documentation/Connection.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ const Users = new QDB.Connection("lib/Databases/Users.qdb");
> | KeyOrPath | Pathlike | Specifies which row or nested array to push to. |
> | Values | ...Any | Values to insert and push to this array. |
>
> Returns **{Connection}** Returns the updated database.
> Returns **{Number}** New length of the array.
## [.Shift(KeyOrPath, Values?)](https://github.com/QSmally/QDB/blob/v4/lib/Connections/Connection.js#L522)
> Inserts (if defined) or removes a value to/from the front of the array.
Expand All @@ -198,7 +198,7 @@ const Users = new QDB.Connection("lib/Databases/Users.qdb");
> | KeyOrPath | Pathlike | Specifies which row or nested array to remove a value from. |
> | Fn | Function | A function that returns a boolean to which value to remove. |
>
> Returns **{Connection}** Returns the updated database.
> Returns **{Number}** New length of the array.
## [.Ensure(KeyOrPath, Input)](https://github.com/QSmally/QDB/blob/v4/lib/Connections/Connection.js#L589)
> 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.
Expand Down
4 changes: 2 additions & 2 deletions Documentation/Output.json
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,7 @@
"{Pathlike} KeyOrPath Specifies which row or nested array to push to.",
"{...Any} Values Values to insert and push to this array."
],
"Returns": "{Connection} Returns the updated database."
"Returns": "{Number} New length of the array."
},
{
"Value": "Shift",
Expand Down Expand Up @@ -329,7 +329,7 @@
"{Pathlike} KeyOrPath Specifies which row or nested array to remove a value from.",
"{Function} Fn A function that returns a boolean to which value to remove."
],
"Returns": "{Connection} Returns the updated database."
"Returns": "{Number} New length of the array."
},
{
"Value": "Ensure",
Expand Down

0 comments on commit 3692899

Please sign in to comment.