From feba92d3ca3e5b31cf34f9c2bc0c663acb373362 Mon Sep 17 00:00:00 2001 From: jxpsert Date: Thu, 25 Apr 2024 12:00:27 +0200 Subject: [PATCH] Added dirty methods --- docs/assets/search.js | 2 +- docs/classes/src_Collection.Collection.html | 16 ++-- docs/classes/src_Database.Database.html | 10 +-- docs/classes/src_Helper.Helper.html | 4 +- docs/classes/src_Model.Model.html | 79 +++++++++++-------- .../src_QueryBuilder.QueryBuilder.html | 16 ++-- docs/modules/index.html | 2 +- docs/modules/src_Collection.html | 2 +- docs/modules/src_Database.html | 2 +- docs/modules/src_Helper.html | 2 +- docs/modules/src_Model.html | 2 +- docs/modules/src_QueryBuilder.html | 2 +- package.json | 2 +- src/Model.ts | 49 ++++++++++++ 14 files changed, 128 insertions(+), 62 deletions(-) diff --git a/docs/assets/search.js b/docs/assets/search.js index 1fce51e..b56da4f 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAACrWb23LjuBGG30W+1WqMIy3fZWdqayep7CSVqdy4XFO0BI+5I4kKSY3juPzuAXgQu6luiRTlKxctNPpHf40GSIKvkyx9zie3d6+TH8lmObmV08kmXrvJ7cRfuv9OppNdtvJX63S5W7n8Q/nf2VOxXvmfFqs4z503n0zepoc95Nniw8d0tXKLIkk3B135n7+1Px/tU8ibfa9Ej7VNt8ejnU8n2zhzm+JQZ+vWiHYwi3STF9luUaTZQL9X2LSPhhkpR17rNgyPSZYXQ5U0RhfS4HsZLKG2uZCCLN4s0/VQDXurC6lYpLvN4EA0RhfSsNsk/9m5oSL2VhdSsXQrVwxWsbcaoQJVnU9xET/EuSNrTvNj74pz0Bsc1r63I912xrLvD7i7lroN4sO/XFEkm+/5AI9XyKp1XuTLX5L8l22W/IzLGJNSZoQma4yye1HfvhUv2yEhAIJme+PTQWk7AQNiAvWUMvWnr6JZ3cN5spphMep2uaOXit7q6h7eRd3W9/mcZstxCkEv76JyOXzqESpBL5dSiape7oov21CQBk1YZDVA15kbFEZF383JMRkIme9wc2R/xstorS5RvToLdNn7GYLOjgleFpP8DAnI6gIq/EqfvQwR0Bic6Rstyb+71RbUQ7ggVz/1Xo47PcFx1D2xHXbU1z0x4fqfy9J/xHSBPHR01TY/5XB23K+vVu5rsna/pdk6phOGcH9gNVzFkGpCKOhbSdggoHz5e+p3hWS6lL/0zhbcDxxC1Q/XW0d01Q17L7ah06Tr4qpuecLP7KS3L9lvcdJvWFeo/SjPu23Isi/Zx8zFzC7/wPuBzSgFS+dTLKWL2IHrtvEon3zZPPB4umD28BeveoKtGo7ytXHPn/2sjTeLnjixwVDfQyrMgeu+9YV2jfYofq1a9Rxw05TYk6SFX5rd8gz/fj+zjrOXv7meeYXaX1TJD/fylbuvO5DRNr6ohsdkteoPBLS+qIpks8jc2pv4DX8/JR2LURmZp4/Fp/IxCH0PceAcG4zyHRdFljzsertG7fvu1WkdvZ8xHBHR5+kCNAfyuaeK7nuSFy77y8DAkHbjAoRvY1YuHizq0OiCir674mv/qQtaj1q1fD+9S+e+7SiPefyz5xjrlhfYZw3ZX431mLnHzOVPfdO8aTzKZ5HuFj09Nk1H7h3ZZ9PE1vHkE+k+O/U0W7hPA9xig5FEc79R6um3bTyS6F9z5rEPgbRuO8pj0rMIJucskh1Pf6T0zTjhrGo6LpZZnD+5nreVbePBPtFN9z/D/cuvu2S1ZB7VwAa9b8HJXuF4UK8nXHRGhfo+70bjuPfetx1sN9y2a80+mTihqDHsu44PVrZIV7s18zD7ZLQa03dT9/zkMvdxFe9yZgt0QmLH/t10ppn/8deXytM5QrsdXFJp7433EI19duJ8f3i4R1PzUkpn++5GCz71IivJjrwUOUc67PG91Z94p3O6gg5/t9MniTsv4Vbc+5UT+vaW44o7UlMWmbOr0zto+WPHPFbso6c2vrgmZkfVS9KJLdZ5ij6fleCt6QX11PNzRL24rB5/I32OlsrsLB330/oQ4u3r5KfL8lBAbidypmZz38tj4lbLcHSxEuh9pOvwMG5yX//2bxf2bKFF1eTD9WR6dz1V89nN/P5+etcYlP8v/1G2Ev5KEK0EaiX9lSRaSdRK+Ss1lda3ilAzhZppf6WJzjRqZfyVIVoZ1Mr6K0u0sqhV5K8iolWEWt34qxui1Q1q5WHczadKz6IbiZrNcVxDmAUVf9EBUBIQVI8CQxAh2oLCIDAHEeIt1FSJmRaYhMAoRIi5oGAITEOEsAuKh8BARIi8oJAIzERE/LgxFxEACIqfwGjEnEtAgeHIEs4N5VtiOrKkM6dSvzNDyilC8ZYYjgwEJDluieHIgECS0w7DkQGBVFRDDEcGBJLCLTEcGQhICrfEbOQNF3KJ2chAQFJ5ITEbFQDIiIqPwmxUICCpGaswG1WyoSCqTgErKxgFUWE0KgBQVN1UGI0yLG2F2ahAQFG0FWajAgFF0VaYjWLZKMxGlfOGSguF2egAQFFpoTEaHQAoirbGaHQAoKi5rTEaXaKhYOvO6lKioWBrjEaH+GsKtsZktGXLqcZodACgqbTQGI0OADQFW2M0OgDQFGyN0ZgAQFMMDUZjAgBNrqwYjQkANMXQYDQmANAUQ4PRmHLlpxiaztpvuEXWYDQmxF9TsA0mY0L8DQXbYDImxN9QCA0mY0L8DYXQYDI2xN9QCC0mY0P8DYXQYjI2xN9QCC0mY0P8Dbk/wmSs5kqFxWSsYauz7ezMAgBDZYXFaGyJhsoKi9HYEg0F22I0ds5OWIvZRIGApdIiwmyiQMBSaRFhNpFktxYRhhMFBJZKoAjDiQICSyVQhOFEgYClEijCbKJy20wlUNTZOAcClkqgCLOJAgFL7rExmygAsBTtqEJT3gb5+5/CLT9Xt0P+hqZ50vY6+VbfI3m89a3a68Rvam9f36YTX43Lvx6y//vW3iOFq+CqPELU9qFk24eynA14l9ya+nVjb+qXC9q0fBfN2APXvuQz9uDbr9YUWEresHzO1xpZoNen9jEzpNNP4L2d5UK0P7YL8MyBSnHcrjM+cQNMryuiET9S8LoCkAVgqx7EvPorb6q/qv7r6xvXc/nBUtsniETE2LQn78FwBEhUUYs50oErkrV7rI+1AuoGRIU1f8j3H8UABSBjBBfI5hVwawYI1rEzXKLvjx4CAmDYiosxeKgLUhVYRlzqwMPiIEggyyU30vZEFVAL4GreMJxmBd5AoipOaDBKs8fyOCowBcFVvL/y80VQNIBIzia8Uj9kqYE/w03j8tkV4ACGF3EV1dv8cAi8BioNV2m8WdFloMGk1Zy/p/o0PAglMJNcglYfPoEpAUQKLpb4wBtIFhAYrVjj8nvi1gqkJheVBJdeMG0NF48k36RoZAaEw3KOPLLuetq+HvOD4pJ5FeMwgprERb5+ewt4gamm6vJuOeuNe07252+BWFjfuWJYPhZ+QLlpYQ3nVt3ablG/hwSjBZPIctbtJ2Ig20BsBTf76kOvndmkQIg1h7M+hw1iDEqorBdAxcW4tH5oziuA4QLVlkvz5ttiEGNgxRk1J6rA5AdkDOusPnDIbKnAoDWXFPujP2CcYGYazq465wacwdTnpkvzpg0EB8zpiBumX8PT5ks5kEQgQoLLvnBMdtkckwVZBDJXc+UuvJ6gd5xwB3PEmNz9gOAKLn+DMVHY4Ub3mOjDEgNyUHKVM1iyqQ/oWm55PljAFFhUFOe2SP/McXQNCK/hwNZHAkECgkXIcNHZH5QC3oBIy9FsvpNvzYA3TmJzNBNoBBwMF8bKzG9b6i9mQDxB7ihuslQfDYOEA+gEV/Lqt85gXoIFJeKiWVotmpM0IKQgOJYrIKVxgje6IDzRUbvOGm/BGCOuyFaGO3zHawH9iItO+LRvG+OtLrCTpEd/275Ntm6VbHyju/u3t/8DN0JryWxFAAA="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAACr2c23LbyBGG34W+pWnNEZDusnZtxUllN6l15calckHkyEJMEgoA2nFUfvfMgADRDXaTA4LOFU1zuvuf/hpzAAZ6mZXFt2p29/Fl9iXfrmZ3cj7bZhs3u5v5r+4/s/lsV679t02x2q1d9ab538VTvVn7n5brrKqcN5/NfsyPPVTl8s3bYr12yzovtkeu/M+f+p9P+hQyPXglPLY2Q48nnc9nz1nptvWxzj6sEX1nlsW2qsvdsi7KkXFfYdMYDQtSjrzRfRoe87KqxyrpjK6kwXsZLaG1uZKCMtuuis1YDQerK6lYFrvt6ER0RlfSsNvm/965sSIOVldSsXJrV49WcbCaoAKNOu+yOnvIKkeOOd2P0SPOkTfYrYO3E24HfTn4A+FupO6T+PCHq+t8+7kaEfEVsuqD19XqdV69fi7zr1mTY1LKgtBkjVH2IOrTp/r785gUAEGLg/H5pPROQIeYRD0VzPgTq2jRerhMVtctRt2ucvRUEa2u9fBT1D17n9+KcjVNIfDyU1Suxl96hErg5Voq0ahXufr35zAgjbpgkdUIXRcuUBgVsYuTUzIQMu9we2J9xsvora4xeg0m6Mb7BYIuzgmeFvPqAgnI6goq/Exffh8joDO4MDaakv/s1s9gPIQT8v6n6Ol44An2o/XEOhyobz0x6fqvK4u/Z/QAeRzoVd/8XMDF6bh+tHIf8o37tSg3GV0wRPgjq/EqxowmhILYkYRNAqqXvxV+VUiWS/NLdLVgP7ALez+ct4HovRt2L7aly2QY4lXb8kycxdlov5e/Znlct16h9pMi755Dlf1evi1dxqzyj6If2UxSsHK+xAp6EDsK3TeeFJMfNo8inh8wI+Jl60iw+4aTYm3dt/f+qs22y0ic2GBs7DEjzFHo2PGFDo3WKH6uWkd2uGtKrEmK2k/NbnVBfL+e2WTl97+6yLpC7a+q5Iv7/oHb1x3J6BtfVcNjvl7HAwGtr6oi3y5Lt/EmfsEfp2RgMakiq+KxftfcBqH3EEfBscGk2Fldl/nDLjo0ah+7Vqd1RN9jOCEi5u4CNAfymYQUZf4532aRwzBoPRbD5d3vgradfy2iu3+Qy91SdZ/zqnbln0ZWBWk3rTrwHm7tstGijo2uqOiz38CPqhRsMGni9q7e5WUdOX+A1v+/Eu2CLrp/vBZdtcroaj1ywiUkr0bko288FcKH+IkLtJ4aNXrhcGg7KWKVfY3sY9vyCruMMbuLqRFL91i66il2nOsaT4pZF7tlZMSu6cSdE/tkhtg4nX0eE7NPLcqlezciLDaYSLTy24TIuH3jiUT/UjE3PQmkbdtJEfPIWTC/ZIk4iPRbQd+KIoLtm07LZZlVTy7ypkrfeHRMdMvpH2H3/ssuX6+YG5WwQfQNKNIr7A/yeibEoFfI92Xb7NPRozfdrBtujb1pUFygqDOMXciNVrYs1rsN8yjnbLY605+m7tuTK93bdbarmDXwGYkD+5+msyj9j79830e6ROjQwTWVRi9qx2iM2Yfy/nB3T5bmtZQuDu4mCz73GDcvTzwSvEQ69Piz1Z95onl+BB3/ZDOmiAePoNfc08Uz+g6W0wZ3pKYZZC4enX6Clt92zE31GD2t8dU1MSuqKElnlliXKXp/UYH3plfU016fE8aL6+rxG+lLtOzNLtJxP2+P4N69zL66sgoDyN1MLtTi1nt5zN16FQ7u7gX6GMUm3Iqe3be//dOFNVtosW/y5mY2/3gz1zcLe6Pv7+cfO4vmh+Y/mmbCfxNUM4GaSf9NUs0kaqb8NzWXycIKiZop1Ez7b5ryplEz478ZqplBzaz/ZqlmFjVL/LeEapagZqn/llLNUtTMQ/l4O1dmoW8tanaL0xuyLUgOYgCiISEolwKzECHngqQhMA4R0i5IIAITESHzgmQiMBQRki9ILAJzESH/giQjMBqR8H3HdESgIEiMAgMSt1wtCoxINohSKrjEiGSD6Ja8DAaXS3O9kNglRiQDB0l2XWJEMnCQ9EWIEcnAQSqyJUYkAwdJYpcYkQwcJIldYkQy5RIvMSEZOEiyPiRGpAIHmVBJUhiRChwkef0qjEg1iEiYajCoNaMaCVNhRCpwUORwqjAiZVjsCiNSgYMisSuMSAUOisSuMCLFIlIYkWouIrI+FEakAwdF1ofGiHTgoEjsGiPSgYMiL3aNEekGEYldD6aeBhGJXWNEOnDQJHaNEWnLDrMaI9KBgyYLRGNEOuV9YkY6gNBkgWjMyAQQmiwQgxmZAEKT3A1mZAIITc/SmJHhJyODGZlmfUBWiBmsEBpGZIUYzMgEEJqsEIMZmYYRWSEGMzIBhCErxGBGJoAwJHeDGdkAwpA0LWZkBbcEsRiRDRwMid1iRDZwMCR2ixHZwMGQ2C1GZJtVHL0+G6zjAgdDwrQYkQ0cDAnTYkS2QUTCtBiRDRwsCdNiRMkNN3ommFAi2GkrwYiSwMGS9ZFgREngYMn6SDCiJHCwJPYEI0oMe2UmGFHSrLXJAkkGq+3AwZIFkmBEScquvxKMKGkQkaWUYERpAGHJUkoxozSAsPSCHzNKG0ZkKaWYURpAJGQppZhRGkAkJPcUM0oDiITknu4ZNRtIv3Os3er9fiPpt4LdPcqX2ad2d+k5t5vcl5nfBNy9/JjP/Cy1/0z3n6b9f0/ff/7od5vhWwjdHEXsfSrZ+1SWswHHMnpTP8EeTDUXrjnWwdiD7vhJjLEH75D2pkC05A2bO6a9kdW9VcJ19fBcANgJYMeHa4//A1y3QKU4bTfon0iB6U1LNOVd9A9+AFkAdu/B756aT9nWimo/Ez75zYuPvc8EZIKx6d/gAd0BGRSiFXPCgavzjXtsj8cD6gZkhTV/qA4v1wEFoGIEx7B7mN6bAYJt7iwH8nCEGRAA3fabCMauvz0OSg70NGF7Cl46AUkCV6XketqfzARqAVzNG4ZT8SAaKFTFpSYYFeVjc6wdmILkKj5e8xo0GDSASM4mHE44ZmnABWG5eM1dQFDvoGxSbojzNqv9GSUgEwA0J4J9cdgMpNNwQ5Q36w8yAluQGsOh8Lb1ELwG4A3Xyaf2VR7AD+RTsmYFxieASMEBxKd1QYWC7GjFGjd/DKG3AtcDN87laKwwFhQK17G8OmYO7Azbt2pboIwYkH3LIfdlMlwMKBBNc7jXGU4/rErGpH1oDzgDgaqbi7iAW/ctP7x0AMTCyYgbz5qnAQ8opQkYQVMupa3dsn38DEZREDXhrYlLCYTVnNz+hVpQ3gCK4GC2rwgMLn0F2GiuUNu3VgAcoFS207zi0DbWD935FpAncInYW8a4+0sMwAxYcUbdCTxQgkCxYYO1J5SZhSMYlTXvoj0qBkKDwcdy48f+XCQIBqYpw9VC92QWJAdkJ+E0+pVK0b1XDIoIXHCCW/SFlwpW3UsFoIqAWs2VfHicRa+r4TrthDG5xgNFJLj6DcbETAKX86dEH49NIMuSzbK35ErfgHxZLtdHM6YChaS4sHXxrwpn14BL3HL9bI+QAiuQHcsl9nCwDtiB2dJyhdv9VZHeDFhx+eiO8oJYAL45beYXZ+37hSCfwFxxF+b+TyyAggPZFNyQ155SANcluLhSLpuN1bI7eQWMAYqE09kY5wh8AvqXnrQbLA4sKM+UW0buDXd4X28hR+5aDi9CP2d4QQ9KW5LD+v189pw/u3W+9Y0+3v/48T/dQoB6mkoAAA=="; \ No newline at end of file diff --git a/docs/classes/src_Collection.Collection.html b/docs/classes/src_Collection.Collection.html index 7390171..1a89da4 100644 --- a/docs/classes/src_Collection.Collection.html +++ b/docs/classes/src_Collection.Collection.html @@ -1,6 +1,6 @@ Collection | nodequent

Class Collection

A collection class that extends the Array class. Mostly for convenience.

-

Hierarchy

  • Array
    • Collection

Constructors

constructor +

Hierarchy

  • Array
    • Collection

Constructors

constructor

Properties

[unscopables] length [species] @@ -46,7 +46,7 @@ from isArray of -

Constructors

constructor

Properties

Readonly [unscopables]

[unscopables]: {
    [unscopables]?: boolean;
    length?: boolean;
    [iterator]?: any;
    at?: any;
    concat?: any;
    copyWithin?: any;
    entries?: any;
    every?: any;
    fill?: any;
    filter?: any;
    find?: any;
    findIndex?: any;
    flat?: any;
    flatMap?: any;
    forEach?: any;
    includes?: any;
    indexOf?: any;
    join?: any;
    keys?: any;
    lastIndexOf?: any;
    map?: any;
    pop?: any;
    push?: any;
    reduce?: any;
    reduceRight?: any;
    reverse?: any;
    shift?: any;
    slice?: any;
    some?: any;
    sort?: any;
    splice?: any;
    toLocaleString?: any;
    toString?: any;
    unshift?: any;
    values?: any;
}

Is an object whose properties have the value 'true' +

Constructors

constructor

Properties

Readonly [unscopables]

[unscopables]: {
    [unscopables]?: boolean;
    length?: boolean;
    [iterator]?: any;
    at?: any;
    concat?: any;
    copyWithin?: any;
    entries?: any;
    every?: any;
    fill?: any;
    filter?: any;
    find?: any;
    findIndex?: any;
    flat?: any;
    flatMap?: any;
    forEach?: any;
    includes?: any;
    indexOf?: any;
    join?: any;
    keys?: any;
    lastIndexOf?: any;
    map?: any;
    pop?: any;
    push?: any;
    reduce?: any;
    reduceRight?: any;
    reverse?: any;
    shift?: any;
    slice?: any;
    some?: any;
    sort?: any;
    splice?: any;
    toLocaleString?: any;
    toString?: any;
    unshift?: any;
    values?: any;
}

Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Type declaration

  • Optional Readonly [unscopables]?: boolean

    Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    @@ -71,9 +71,9 @@
  • Optional end: number

    If not specified, length of the this object is used as its default value.

Returns this

count

  • count(): number

  • Return the number of items in the collection. To stay in the Laravel spirit.

    Returns number

    The length of the collection

    -

delete

delete

  • delete(): void

  • Delete all models in the collection.

    Returns void

    void

    -

entries

  • entries(): IterableIterator<[number, any]>

  • Returns an iterable of key, value pairs for every entry in the array

    +

entries

  • entries(): IterableIterator<[number, any]>

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, any]>

every

  • every<S>(predicate, thisArg?): this is S[]

  • Determines whether all the members of an array satisfy the specified test.

    Type Parameters

    • S extends any

    Parameters

    • predicate: ((value, index, array) => value is S)

      A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value @@ -115,7 +115,7 @@

    Returns number

first

  • first(amount?): any

  • Get the first (x) item(s) from the collection.

    Parameters

    • Optional amount: number

      The amount of items to get. Optional.

    Returns any

    any

    -

flat

  • flat<A, D>(this, depth?): FlatArray<A, D>[]

  • Returns a new array with all sub-array elements concatenated into it recursively up to the +

flat

  • flat<A, D>(this, depth?): FlatArray<A, D>[]

  • Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

    Type Parameters

    • A
    • D extends number = 1

    Parameters

    • this: A
    • Optional depth: D

      The maximum recursion depth

    Returns FlatArray<A, D>[]

flatMap

  • flatMap<U, This>(callback, thisArg?): U[]

  • Calls a defined callback function on each element of an array. Then, flattens the result into @@ -140,7 +140,7 @@

    Returns IterableIterator<number>

last

  • last(amount?): any

  • Get the last (x) item(s) from the collection.

    Parameters

    • Optional amount: number

      The amount of items to get. Optional.

    Returns any

    any

    -

lastIndexOf

  • lastIndexOf(searchElement, fromIndex?): number

  • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

    +

lastIndexOf

  • lastIndexOf(searchElement, fromIndex?): number

  • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

    Parameters

    • searchElement: any

      The value to locate in the array.

    • Optional fromIndex: number

      The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn, thisArg?): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    @@ -152,7 +152,7 @@

    Parameters

    • Rest ...items: any[]

      New elements to add to the array.

    Returns number

random

  • random(): any

  • Get a pseudo-random item from the collection.

    Returns any

    any

    -

reduce

  • reduce(callbackfn): any

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    +

reduce

  • reduce(callbackfn): any

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: ((previousValue, currentValue, currentIndex, array) => any)

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue, currentValue, currentIndex, array): any

        • Parameters

          • previousValue: any
          • currentValue: any
          • currentIndex: number
          • array: any[]

          Returns any

    Returns any

  • reduce(callbackfn, initialValue): any

  • Parameters

    • callbackfn: ((previousValue, currentValue, currentIndex, array) => any)
        • (previousValue, currentValue, currentIndex, array): any

        • Parameters

          • previousValue: any
          • currentValue: any
          • currentIndex: number
          • array: any[]

          Returns any

    • initialValue: any

    Returns any

  • reduce<U>(callbackfn, initialValue): U

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type Parameters

    • U

    Parameters

    • callbackfn: ((previousValue, currentValue, currentIndex, array) => U)

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

      @@ -199,7 +199,7 @@

      Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unique

unshift

  • unshift(...items): number

  • Inserts new elements at the start of an array, and returns the new length of the array.

    +

unshift

  • unshift(...items): number

  • Inserts new elements at the start of an array, and returns the new length of the array.

    Parameters

    • Rest ...items: any[]

      Elements to insert at the start of the array.

    Returns number

values

  • values(): IterableIterator<any>

  • Returns an iterable of values in the array

    Returns IterableIterator<any>

Static from

  • from<T>(arrayLike): T[]

  • Creates an array from an array-like object.

    diff --git a/docs/classes/src_Database.Database.html b/docs/classes/src_Database.Database.html index 21b2482..eef412b 100644 --- a/docs/classes/src_Database.Database.html +++ b/docs/classes/src_Database.Database.html @@ -1,5 +1,5 @@ Database | nodequent

    Class Database

    Database class to handle database connections and interactions.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    connection dbSettings

    Methods

    connect @@ -9,9 +9,9 @@

    Constructors

    constructor

    • new Database(options?): Database

    • Create a new instance of the Database class.

      Parameters

      • Optional options: any

        The options to use for the database connection.

      Returns Database

      void

      -

    Properties

    Private connection

    connection: any = null

    Static Private dbSettings

    dbSettings: {
        database: string;
        host: string;
        password: string;
        user: string;
    }

    Type declaration

    • database: string
    • host: string
    • password: string
    • user: string

    Methods

    connect

    Properties

    Private connection

    connection: any = null

    Static Private dbSettings

    dbSettings: {
        database: string;
        host: string;
        password: string;
        user: string;
    }

    Type declaration

    • database: string
    • host: string
    • password: string
    • user: string

    Methods

    connect

    disconnect

    disconnect

    • disconnect(): void

    • Disconnect from the database.

      Returns void

      void

      -

    query

    • query(sql): Promise<unknown>

    • Parameters

      • sql: string

      Returns Promise<unknown>

    Static setOptions

    • setOptions(options): void

    • Set the default database options. Mainly for the init function.

      -

      Parameters

      • options: {
            database: string;
            host: string;
            password: string;
            user: string;
        }
        • database: string
        • host: string
        • password: string
        • user: string

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    constructorconnectiondbSettingsconnectdisconnectquerysetOptions
    \ No newline at end of file +

query

  • query(sql): Promise<unknown>

  • Parameters

    • sql: string

    Returns Promise<unknown>

Static setOptions

  • setOptions(options): void

  • Set the default database options. Mainly for the init function.

    +

    Parameters

    • options: {
          database: string;
          host: string;
          password: string;
          user: string;
      }
      • database: string
      • host: string
      • password: string
      • user: string

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorconnectiondbSettingsconnectdisconnectquerysetOptions
\ No newline at end of file diff --git a/docs/classes/src_Helper.Helper.html b/docs/classes/src_Helper.Helper.html index 80bf949..02fa595 100644 --- a/docs/classes/src_Helper.Helper.html +++ b/docs/classes/src_Helper.Helper.html @@ -1,4 +1,4 @@ -Helper | nodequent

Class Helper

Constructors

constructor +Helper | nodequent

Class Helper

Constructors

constructor

Methods

dateTimeFormat zeroPad -

Constructors

constructor

Methods

Static dateTimeFormat

  • dateTimeFormat(date): string

  • Parameters

    • date: any

    Returns string

Static zeroPad

  • zeroPad(num, places): string

  • Parameters

    • num: number
    • places: number

    Returns string

Settings

Member Visibility

Theme

On This Page

constructordateTimeFormatzeroPad
\ No newline at end of file +

Constructors

constructor

Methods

Static dateTimeFormat

  • dateTimeFormat(date): string

  • Parameters

    • date: any

    Returns string

Static zeroPad

  • zeroPad(num, places): string

  • Parameters

    • num: number
    • places: number

    Returns string

Settings

Member Visibility

Theme

On This Page

constructordateTimeFormatzeroPad
\ No newline at end of file diff --git a/docs/classes/src_Model.Model.html b/docs/classes/src_Model.Model.html index 55504ca..628e0c2 100644 --- a/docs/classes/src_Model.Model.html +++ b/docs/classes/src_Model.Model.html @@ -1,18 +1,22 @@ Model | nodequent

Class Model

Base class for all models.

-

Constructors

constructor +

Constructors

constructor

Properties

attributes fillable incrementing keyType +original primaryKey softDeletes table

Methods

clearAttributes delete forceDelete +getDirty getKey +getOriginal getTable is +isDirty isNot refresh registerAttributes @@ -29,63 +33,76 @@ newInstance query updateOrCreate -

Constructors

constructor

Properties

Private attributes

attributes: {} = {}

Type declaration

    Var

    object The model's attributes.

    -

    Protected fillable

    fillable: string[] = []

    Var

    string[] The attributes that are mass assignable.

    -

    incrementing

    incrementing: boolean = true

    Var

    bool Indicates if the IDs are auto-incrementing.

    -

    Protected keyType

    keyType: string = 'int'

    Var

    string The type of the primary key.

    -

    Protected primaryKey

    primaryKey: string = 'id'

    Var

    string The primary key for the model.

    -

    softDeletes

    softDeletes: boolean = false

    Var

    bool Whether or not soft deletes are enabled.

    -

    Protected table

    table: string

    Var

    string The table associated with the model.

    -

    Methods

    Private clearAttributes

    • clearAttributes(): void

    • Clear the model's attributes.

      -

      Returns void

    delete

    • delete(): Promise<unknown>

    • Remove the model from the database

      +

    Constructors

    constructor

    Properties

    Private attributes

    attributes: {} = {}

    Type declaration

      Var

      object The model's attributes.

      +

      Protected fillable

      fillable: string[] = []

      Var

      string[] The attributes that are mass assignable.

      +

      incrementing

      incrementing: boolean = true

      Var

      bool Indicates if the IDs are auto-incrementing.

      +

      Protected keyType

      keyType: string = 'int'

      Var

      string The type of the primary key.

      +

      original

      original: {} = {}

      Type declaration

        Var

        object The original attributes of the model.

        +

        Since

        1.0.5

        +

        Protected primaryKey

        primaryKey: string = 'id'

        Var

        string The primary key for the model.

        +

        softDeletes

        softDeletes: boolean = false

        Var

        bool Whether or not soft deletes are enabled.

        +

        Protected table

        table: string

        Var

        string The table associated with the model.

        +

        Methods

        Private clearAttributes

        • clearAttributes(): void

        • Clear the model's attributes.

          +

          Returns void

        delete

        • delete(): Promise<unknown>

        • Remove the model from the database

          Returns Promise<unknown>

          void

          -

        forceDelete

        • forceDelete(): Promise<unknown>

        • Delete the model from the database, regardless of soft deletes.

          +

        forceDelete

        • forceDelete(): Promise<unknown>

        • Delete the model from the database, regardless of soft deletes.

          Returns Promise<unknown>

          void

          -

        getKey

        getDirty

        • getDirty(): {}

        • Gets attributes that are different than the original attributes.

          +

          Returns {}

          object The model's dirty attributes

          +

            Since

            1.0.5

            +

          getKey

          • getKey(): any

          • Get the value of the primary key

            Returns any

            The primary key

            -

          getTable

          getOriginal

          • getOriginal(key): any

          • Get the original value of an attribute.

            +

            Parameters

            • key: string

              The attribute

              +

            Returns any

            The value of the attribute

            +

            Since

            1.0.5

            +

          getTable

          • getTable(): string

          • Get the table name

            Returns string

            The table name

            -

          is

          • is(model): boolean

          • Check if the model is the same as another model.

            +

          is

          • is(model): boolean

          • Check if the model is the same as another model.

            Parameters

            • model: Model

              The model to check against

            Returns boolean

            boolean

            -

          isNot

          • isNot(model): boolean

          • Check if the model is not the same as another model.

            +

          isDirty

          • isDirty(key?): boolean

          • Check if the model, or a specific attribute, is dirty.

            +

            Parameters

            • Optional key: string

              The attribute to check

              +

            Returns boolean

            boolean

            +

            Since

            1.0.5

            +

          isNot

          • isNot(model): boolean

          • Check if the model is not the same as another model.

            Parameters

            • model: Model

              The model to check against

            Returns boolean

            boolean

            -

          refresh

          • refresh(): Promise<unknown>

          • Refresh the model from the database

            +

          refresh

          • refresh(): Promise<unknown>

          • Refresh the model from the database

            Returns Promise<unknown>

            Model

            -

          Private registerAttributes

          • registerAttributes(attributes?): void

          • Register getters and setters for the model's attributes.

            +

          Private registerAttributes

          • registerAttributes(attributes?): void

          • Register getters and setters for the model's attributes.

            Parameters

            • attributes: any = {}

              The attributes to register.

              -

            Returns void

          restore

          • restore(): Promise<unknown>

          • Restore a soft-deleted model. Only works if soft deletes are enabled.

            +

          Returns void

          restore

          • restore(): Promise<unknown>

          • Restore a soft-deleted model. Only works if soft deletes are enabled.

            Returns Promise<unknown>

            void

            -

          save

          • save(): Promise<unknown>

          • Save the model to the database

            +

          save

          • save(): Promise<unknown>

          • Save the model to the database

            Returns Promise<unknown>

            void

            -

          toJson

          • toJson(): string

          • Return the model's attributes as a JSON string.

            +

          toJson

          • toJson(): string

          • Return the model's attributes as a JSON string.

            Returns string

            The JSON string

            -

          touch

          • touch(): Promise<unknown>

          • Touch the timestamps on the model

            +

          touch

          • touch(): Promise<unknown>

          • Touch the timestamps on the model

            Returns Promise<unknown>

            void

            -

          trashed

          • trashed(): Promise<boolean>

          • Check whether the model has been soft-deleted.

            +

          trashed

          • trashed(): Promise<boolean>

          • Check whether the model has been soft-deleted.

            Returns Promise<boolean>

            boolean

            -

          update

          • update(attributes): Promise<unknown>

          • Update the model's attributes

            +

          update

          • update(attributes): Promise<unknown>

          • Update the model's attributes

            Parameters

            • attributes: any

              The attributes to update

            Returns Promise<unknown>

            void

            -

          Static all

          Static all

          Static destroy

          • destroy(ids): Promise<unknown>

          • Destroy the models for the given primary keys.

            +

          Static destroy

          • destroy(ids): Promise<unknown>

          • Destroy the models for the given primary keys.

            Parameters

            • ids: any[]

              An array of primary keys to destroy

            Returns Promise<unknown>

            void

            -

          Static find

          Static find

          • find(id): Promise<Model>

          • Find a model by its primary key.

            Parameters

            • id: any

              The primary key value of the model to find

            Returns Promise<Model>

            Promise

            -

          Static findOrFail

          • findOrFail(id): Promise<Model>

          • Find a model by its primary key, and throw an error if not found.

            +

          Static findOrFail

          • findOrFail(id): Promise<Model>

          • Find a model by its primary key, and throw an error if not found.

            Parameters

            • id: any

              The primary key value of the model to find

            Returns Promise<Model>

            Promise

            -

          Static newInstance

          Static newInstance

          • newInstance(attributes?): Model

          • Create a new model instance.

            Parameters

            • attributes: any = {}

              The attributes to create the model with.

            Returns Model

            Model

            -

          Static query

          Static query

          Static updateOrCreate

          • updateOrCreate(search, attributes): Promise<Model>

          • Find a model by the given search criteria and update it, or create a new one with the given attributes.

            +

          Static updateOrCreate

          • updateOrCreate(search, attributes): Promise<Model>

          • Find a model by the given search criteria and update it, or create a new one with the given attributes.

            Parameters

            • search: {}

              The search criteria

              • attributes: {}

                The attributes to be updated or inserted

                Returns Promise<Model>

                Promise

                -

              Settings

              Member Visibility

              Theme

              On This Page

              constructorattributesfillableincrementingkeyTypeprimaryKeysoftDeletestableclearAttributesdeleteforceDeletegetKeygetTableisisNotrefreshregisterAttributesrestoresavetoJsontouchtrashedupdatealldestroyfindfindOrFailnewInstancequeryupdateOrCreate
              \ No newline at end of file +

              Settings

              Member Visibility

              Theme

              On This Page

              constructorattributesfillableincrementingkeyTypeoriginalprimaryKeysoftDeletestableclearAttributesdeleteforceDeletegetDirtygetKeygetOriginalgetTableisisDirtyisNotrefreshregisterAttributesrestoresavetoJsontouchtrashedupdatealldestroyfindfindOrFailnewInstancequeryupdateOrCreate
              \ No newline at end of file diff --git a/docs/classes/src_QueryBuilder.QueryBuilder.html b/docs/classes/src_QueryBuilder.QueryBuilder.html index cf80cbb..cf02e28 100644 --- a/docs/classes/src_QueryBuilder.QueryBuilder.html +++ b/docs/classes/src_QueryBuilder.QueryBuilder.html @@ -1,5 +1,5 @@ QueryBuilder | nodequent

              Class QueryBuilder

              Builds SQL queries for models.

              -

              Constructors

              constructor +

              Constructors

              constructor

              Properties

              columns connection model @@ -12,26 +12,26 @@ whereIn whereNot whereNull -

              Constructors

              constructor

              Properties

              Private columns

              columns: string[] = []

              Private connection

              connection: any

              Private model

              model: any

              Private orderByClause

              orderByClause: {
                  column: string;
                  direction: string;
              } = ...

              Type declaration

              • column: string
              • direction: string

              Private whereClauses

              whereClauses: {
                  column: string;
                  operator: string;
                  value: any;
              }[] = []

              Type declaration

              • column: string
              • operator: string
              • value: any

              Methods

              get

              orderBy

              • orderBy(column, direction?): this

              • Parameters

                • column: string

                  The column to order by

                  +

              Constructors

              constructor

              Properties

              Private columns

              columns: string[] = []

              Private connection

              connection: any

              Private model

              model: any

              Private orderByClause

              orderByClause: {
                  column: string;
                  direction: string;
              } = ...

              Type declaration

              • column: string
              • direction: string

              Private whereClauses

              whereClauses: {
                  column: string;
                  operator: string;
                  value: any;
              }[] = []

              Type declaration

              • column: string
              • operator: string
              • value: any

              Methods

              get

              orderBy

              • orderBy(column, direction?): this

              • Parameters

                • column: string

                  The column to order by

                • direction: string = 'asc'

                  The direction to order in

                Returns this

                QueryBuilder

                -

              select

              select

              • select(...columns): this

              • Select columns

                Parameters

                • Rest ...columns: string[]

                  Columns to select.

                Returns this

                QueryBuilder

                -

              where

              where

              • where(column, operator?, value?): this

              • Add a WHERE clause to the query.

                Parameters

                • column: string

                  The column to check on

                • Optional operator: any

                  The operator to use

                • Optional value: any

                  The value to check against

                Returns this

                QueryBuilder

                -

              whereIn

              • whereIn(column, values): this

              • Convenience method for where(column, 'IN', values)

                +

              whereIn

              • whereIn(column, values): this

              • Convenience method for where(column, 'IN', values)

                Parameters

                • column: string

                  The column to check on

                • values: any[]

                  The values to check against

                Returns this

                QueryBuilder

                -

              whereNot

              whereNot

              • whereNot(column, value): this

              • Convenience method for the inverse of where()

                Parameters

                • column: string

                  The column to check on

                • value: any

                  The value to check against

                Returns this

                QueryBuilder

                -

              whereNull

              whereNull

              • whereNull(column): this

              • Where clause to check for null values

                Parameters

                • column: string

                  The column to check on

                Returns this

                QueryBuilder

                -

              Settings

              Member Visibility

              Theme

              On This Page

              constructorcolumnsconnectionmodelorderByClausewhereClausesgetorderByselectwherewhereInwhereNotwhereNull
              \ No newline at end of file +

              Settings

              Member Visibility

              Theme

              On This Page

              constructorcolumnsconnectionmodelorderByClausewhereClausesgetorderByselectwherewhereInwhereNotwhereNull
              \ No newline at end of file diff --git a/docs/modules/index.html b/docs/modules/index.html index 0b3a77c..452f16f 100644 --- a/docs/modules/index.html +++ b/docs/modules/index.html @@ -1 +1 @@ -index | nodequent

              Module index

              Settings

              Member Visibility

              Theme

              \ No newline at end of file +index | nodequent

              Module index

              Settings

              Member Visibility

              Theme

              \ No newline at end of file diff --git a/docs/modules/src_Collection.html b/docs/modules/src_Collection.html index 306e7c2..3ea6846 100644 --- a/docs/modules/src_Collection.html +++ b/docs/modules/src_Collection.html @@ -1,2 +1,2 @@ -src/Collection | nodequent

              Module src/Collection

              Index

              Classes

              Collection +src/Collection | nodequent

              Module src/Collection

              Index

              Classes

              Collection

              Settings

              Member Visibility

              Theme

              \ No newline at end of file diff --git a/docs/modules/src_Database.html b/docs/modules/src_Database.html index 2171b57..430a112 100644 --- a/docs/modules/src_Database.html +++ b/docs/modules/src_Database.html @@ -1,2 +1,2 @@ -src/Database | nodequent

              Module src/Database

              Index

              Classes

              Database +src/Database | nodequent

              Module src/Database

              Index

              Classes

              Database

              Settings

              Member Visibility

              Theme

              \ No newline at end of file diff --git a/docs/modules/src_Helper.html b/docs/modules/src_Helper.html index 61a5d65..d0ba037 100644 --- a/docs/modules/src_Helper.html +++ b/docs/modules/src_Helper.html @@ -1,2 +1,2 @@ -src/Helper | nodequent

              Module src/Helper

              Index

              Classes

              Helper +src/Helper | nodequent

              Module src/Helper

              Index

              Classes

              Helper

              Settings

              Member Visibility

              Theme

              \ No newline at end of file diff --git a/docs/modules/src_Model.html b/docs/modules/src_Model.html index 22bb273..62917c2 100644 --- a/docs/modules/src_Model.html +++ b/docs/modules/src_Model.html @@ -1,2 +1,2 @@ -src/Model | nodequent

              Module src/Model

              Index

              Classes

              Model +src/Model | nodequent

              Module src/Model

              Index

              Classes

              Model

              Settings

              Member Visibility

              Theme

              \ No newline at end of file diff --git a/docs/modules/src_QueryBuilder.html b/docs/modules/src_QueryBuilder.html index 8809303..3f4f6b8 100644 --- a/docs/modules/src_QueryBuilder.html +++ b/docs/modules/src_QueryBuilder.html @@ -1,2 +1,2 @@ -src/QueryBuilder | nodequent

              Module src/QueryBuilder

              Index

              Classes

              QueryBuilder +src/QueryBuilder | nodequent

              Module src/QueryBuilder

              Index

              Classes

              QueryBuilder

              Settings

              Member Visibility

              Theme

              \ No newline at end of file diff --git a/package.json b/package.json index 31cafb4..28b464f 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "nodequent", - "version": "1.0.4", + "version": "1.0.5", "description": "Laravel Eloquent for Node.js", "main": "dist/index.js", "scripts": { diff --git a/src/Model.ts b/src/Model.ts index 5550eb6..e769bae 100644 --- a/src/Model.ts +++ b/src/Model.ts @@ -42,12 +42,19 @@ export class Model { */ private attributes = {}; + /** + * @var object The original attributes of the model. + * @since 1.0.5 + */ + public original = {}; + constructor(attributes: any = {}) { if (attributes) { this.attributes = attributes; this.registerAttributes(attributes); } + this.original = Object.assign({}, attributes); this.registerAttributes(this.fillable); } @@ -83,6 +90,45 @@ export class Model { }); } + /** + * Get the original value of an attribute. + * @param key The attribute + * @returns The value of the attribute + * @since 1.0.5 + */ + public getOriginal(key: string): any { + return this.original[key]; + } + + /** + * Gets attributes that are different than the original attributes. + * @returns object The model's dirty attributes + * @since 1.0.5 + */ + public getDirty() { + let dirty = {}; + Object.keys(this.attributes).forEach((key) => { + if (this.attributes[key] !== this.original[key]) { + dirty[key] = this.attributes[key]; + } + }); + return dirty; + } + + /** + * Check if the model, or a specific attribute, is dirty. + * @param [key] The attribute to check + * @returns boolean + * @since 1.0.5 + */ + public isDirty(key?: string): boolean { + if (key) { + return this.attributes[key] !== this.original[key]; + } + + return Object.keys(this.getDirty()).length > 0; + } + /** * Get the table name * @returns The table name @@ -145,6 +191,8 @@ export class Model { attributes['updated_at'] = 'NOW()'; + this.original = this.attributes; + if (this.attributes[this.primaryKey]) { sql = `UPDATE ${this.table} SET ${Object.keys(attributes).map(key => `${key} = ${attributes[key]}`).join(', ')} WHERE ${this.primaryKey} = ${this.attributes[this.primaryKey]}`; } else { @@ -202,6 +250,7 @@ export class Model { return new Promise(async (resolve) => { const model = await (this.constructor as typeof Model).find(this.attributes[this.primaryKey]); this.attributes = model.attributes; + this.original = Object.assign({}, this.attributes); this.registerAttributes(this.attributes); resolve(this); });