From 4627d9b91917cbf93b7b282adf57b6a73c927327 Mon Sep 17 00:00:00 2001 From: Gerold Penz Date: Mon, 23 Sep 2024 21:56:39 +0200 Subject: [PATCH] API-Docs --- README.md | 1 + docs/{api => }/.nojekyll | 0 docs/api/assets/navigation.js | 1 - docs/api/assets/search.js | 1 - docs/api/classes/BunSqliteKeyValue.html | 111 -------- docs/api/modules.html | 2 - docs/{api => }/assets/highlight.css | 0 docs/{api => }/assets/icons.js | 0 docs/{api => }/assets/icons.svg | 0 docs/{api => }/assets/main.js | 0 docs/assets/navigation.js | 1 + docs/assets/search.js | 1 + docs/{api => }/assets/style.css | 0 docs/classes/index.BunSqliteKeyValue.html | 143 +++++++++++ docs/{api => }/index.html | 27 +- docs/interfaces/interfaces.Item.html | 2 + docs/interfaces/interfaces.Options.html | 16 ++ docs/interfaces/interfaces.Record.html | 2 + docs/modules/index.html | 7 + docs/modules/interfaces.html | 9 + docs/types/interfaces.Field.html | 2 + docs/types/interfaces.Key.html | 2 + docs/types/interfaces.MaxExpiringItems.html | 5 + docs/types/interfaces.Tag.html | 2 + docs/types/interfaces.TtlMs.html | 6 + .../index.INDEX_OUT_OF_RANGE_ERROR_LABEL.html | 2 + .../index.INVALID_COUNT_ERROR_LABEL.html | 2 + docs/variables/index.ITEM_NOT_EXISTS.html | 2 + .../index.ITEM_NOT_EXISTS_ERROR_LABEL.html | 2 + .../variables/index.NO_ARRAY_ERROR_LABEL.html | 2 + package.json | 2 +- src/index.ts | 239 ++++++++++++++---- tests/memory.test.ts | 26 +- typedoc.json | 16 +- 34 files changed, 449 insertions(+), 185 deletions(-) rename docs/{api => }/.nojekyll (100%) delete mode 100644 docs/api/assets/navigation.js delete mode 100644 docs/api/assets/search.js delete mode 100644 docs/api/classes/BunSqliteKeyValue.html delete mode 100644 docs/api/modules.html rename docs/{api => }/assets/highlight.css (100%) rename docs/{api => }/assets/icons.js (100%) rename docs/{api => }/assets/icons.svg (100%) rename docs/{api => }/assets/main.js (100%) create mode 100644 docs/assets/navigation.js create mode 100644 docs/assets/search.js rename docs/{api => }/assets/style.css (100%) create mode 100644 docs/classes/index.BunSqliteKeyValue.html rename docs/{api => }/index.html (99%) create mode 100644 docs/interfaces/interfaces.Item.html create mode 100644 docs/interfaces/interfaces.Options.html create mode 100644 docs/interfaces/interfaces.Record.html create mode 100644 docs/modules/index.html create mode 100644 docs/modules/interfaces.html create mode 100644 docs/types/interfaces.Field.html create mode 100644 docs/types/interfaces.Key.html create mode 100644 docs/types/interfaces.MaxExpiringItems.html create mode 100644 docs/types/interfaces.Tag.html create mode 100644 docs/types/interfaces.TtlMs.html create mode 100644 docs/variables/index.INDEX_OUT_OF_RANGE_ERROR_LABEL.html create mode 100644 docs/variables/index.INVALID_COUNT_ERROR_LABEL.html create mode 100644 docs/variables/index.ITEM_NOT_EXISTS.html create mode 100644 docs/variables/index.ITEM_NOT_EXISTS_ERROR_LABEL.html create mode 100644 docs/variables/index.NO_ARRAY_ERROR_LABEL.html diff --git a/README.md b/README.md index 222ece4..6f6e052 100644 --- a/README.md +++ b/README.md @@ -82,6 +82,7 @@ The ideas for the implementation come from - `rPop()` --> Returns elements at the end of the list and removes them. - `lIndex()` --> Returns the element at the specified index of the list. - `lLen()` --> Returns the length of the list. + - `lSet()` --> Updates the element at the specified index of the list. - Tags (Labels) - `addTag()` --> Adds a tag to an item. - `deleteTag()` --> Deletes a tag of an item. diff --git a/docs/api/.nojekyll b/docs/.nojekyll similarity index 100% rename from docs/api/.nojekyll rename to docs/.nojekyll diff --git a/docs/api/assets/navigation.js b/docs/api/assets/navigation.js deleted file mode 100644 index 2e32912..0000000 --- a/docs/api/assets/navigation.js +++ /dev/null @@ -1 +0,0 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA4uuVipJrShRslJyKs0LLszJLEn1Tq0MS8wpTVXSUSpILMlQslJKzkksLk4t1sdQopdRkpujpKOUnZmXomRlaGRRGwsAijsZtlEAAAA=" \ No newline at end of file diff --git a/docs/api/assets/search.js b/docs/api/assets/search.js deleted file mode 100644 index c52ba94..0000000 --- a/docs/api/assets/search.js +++ /dev/null @@ -1 +0,0 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA+1bS5PjuJH+L/RlDzCbeAN1XNvhmPAeHLEbc+ntmGBLrBLdepmiqqa3o//7RuLBIiAmRUkVPvlUWRSYmUjk40MC/FF0h7dT8fT5R/Gt3a+LJ8oMKfb1rimeiv887//7n9u2b/7WfP+13p6bghTnbls8FattfTo1p08XI8pNv9sWJA4onoriJ4m8WSXema+bbdM3f/n92HbNeiHjP+QvjcSQ4lh3zb6f1HtWh9uEPy51tW3qbqnQOPhhmYfT4onGwQ/KfGn6Px3O+36p2NH4D5L8a71tF/tW/tKDOpya/pe+2Z2Wih+Nv10yrZgYJG/+1nxfLDYOvl2mkpKrQehvv/Xfj4s9zEkth3cWCi+9sojBN39tejds+dzHbzxq9F/r7XLBYfC/2OggNRj9j+wWszt1MbP/+aYk+j78wfja/LJfLc6icfCjMv/c3CAzDH5Q5vbv59Nmqcw4+EGZ3S0yu4+Ruf374bh8mm7sw7NcLrH7EInbX/br5vfFs4yjH5X6X81+sUw/9kGJ9Xr9P/XLUpnD6A9BczcIHr/wUbIX14DkjY+S/tKsbwIdUy8u1uULKVrnoU8/itemO7WHffFUsJKXtiDFc9ts17Cz8EqSYnXY7RqH7taH1dmRX8KwX5tVf+hgsB/9qSrI54qwqhScfvlCPseX3Q+U0FIbRRjhpRCccCJKoTQRhJZMCCIJLY2VRBFWCi6IDn8NYSXlgtjwP60CA0ojwQgtKZOE8vhEEFYaGCzjE+UJp1acidPLPXHqU9BSE2ZKW4lEf/cLKCIUI9QSWlrDCANNqGKEUZiLzpjThDnzLKgsLU2NwyJzpgxhjIiSMkoYB3swRZggvOSWESbjGEVoWVlDmI6E8W+lCrBEAV6Qz8xOzY5HBSRVMDtWViBX+icpT57wFAX5zCvCeKmtTHjCL4bwslJhfTijhIPBONOEU+BdScIZLJTUhIM7VIISLiIhPZHKF4l8CfLVlHz4BWaiNfcLxqSGBfNP3NyotKAILbU0hGtSlRZUM6QqjeKE2zBGVPBECCJgsFSUCKc1V0TwSMAiWcaJAM4cdFeBs9DxiQkihA1PZBUJ4MytJjJyljwMlt6Vs2WQiRlUQT6DmEszwC9u+gL4OHGwwC7WKuXXoeKCgBFLXVGwAy0rzbwdrDODH+vMoIGg8YkKbwsTXnIzAzZuZo6AAGSGEqkioSNhImE9kU5RJVPUBfmsqinv1SG3KKtcjmDCeo+reFhfG6djqPDz0ZL6+VjKvPGl0kTFwRDSjg+4QUkNJUpEQkZCRUJHwkTCBkJXkaCRYJ5Ip6qTqZqCfAYfvZyq+wU00YoTLZ1jcKIVEaXUGU+T8LTw5qSH2DhueNOmSRFypDZTr1Kf72kpwZxgcSpdGreWKOc9mmiXKyGLV6VhDFYGrK4hKKtSGmAcCXiHSw5pzRMuKAXnfvWUFX7RBHgaBW/kIcyEDy4Y6lazAq8CvppqWE2vopZBCe19WhNTuQTKiKFhjAH9lOTEOLU4MRB/TFNiZByr4tvD5Ez8yQbCRsaWRoJFgofXLXBWRhEbOVsVCeCsKkNs5GwjZ1pV4X1a0eEZGyg+UMJbiFZyeKQGSg+UGahBBK2CESilA8UCO8rjUlIxvDCIoIMIOoiggwi36N4NooFcrSullITCc2dPysIssoKalWtXlZmYLNh0OlSMf5LxTSs1ZWiwuJ/+7fH/9vh/lcenEI46pAbgZcLjeaiDlSVgBwurBzMwsCCgj/T+pgHb6UD4Kk9DdZdG+VouuAVvAmCuvadYpmD1eQlmAXPRkgtvLlqCN7iSCyIdkgCEwfRAmYGykeJV4EodCPHP2PCMuwosCCD/+Ez6cZmJUkRKASBSgDMTJoLfHHhmNIBnICjXk1khhZpUOsZmkrG8iXEK3qjDaHwSmbvf3KrZivlVA8KvmpABw0gK0IWVFEKYllwK53fwgIrKbZtgSwQYhEMEO/iqYdGEi0wlCHUA1v8qBwqWklv41UWnstlEUohGHRIT0xbSHziRKfUvVCVU2DgRWQ1UMEI2kRSAUcBOFKD4xETcby4xSFcBBOM+zlRFfWY3NEQaoGHt/zrP5h5dcxvSu60CHJWaxl2G9gHIjPbpHLgaeFkzFqxiDaRoWopK+bRpAZFXIjAKkQhUkAq2g1LFgsXcb85OwJRKt4nRsDeF/FxBGnOwHQqLBK+WkPckvGBAX2mGZzZSymWEzKwpBqUALCks8IRZbTQrs96soAWYVVoVzFqFgilMSGBAuCkyY4NpjY6mpcG0KlqWR8uGQgmMvWUpj5b1hoUH3rB8MKyKdlXBrCAzGBZGeMOqaFfKozWhPDlrCqh13pxQxrwRHWUj5YzoGLsdiIE6rnwfIDdtCtKZa7CoSSjkf3PIQAXMQqQrECpiExEMC6BHB8IhEWlksCcAD7AjN9IjEXhdAmEMDwY10oMJeOIMKj2a8E98hYcQBeOUrnIwv+NSoRIypZ0lg3JieMPVIqFlMKoW0pkoPFOuMIB5lcNGUGOVHijAfIIbQpWNb7iNmXumaRyn2UDxgRIDJQdqkKEHGRA8gbKRckjLU4MMM8gwgwwzyHB4y+nnAJezkENcTGUJi6VImPn+1GTmdb85FxbaQVVq/bLDVt7hGR3iSuoQV0C45YchfuNs/Oo7QGrCL25RKil8FEkb1lwIH0WQ3y1AAAezXBSBaAcdKiUDdPAUJywEEwxxyRzi1HsAMPKhIVlcRTC4M5cjfPLnwVpulHFlw3XrqoGiA8U8lVk169i5xpyd3In730BfaH/APJj0KYgZ9t5Deu8GOVSl7KjTExs8KragAqqCOKFxFMAkSCLSAaFAGd8iZW6+4Zl1ex2wlJVD20uFZhK1sQdFoVkYKBt+ZVU11WJiKfZkrn9YTWZvFrEnAyVdKlUmZGTo8phQ7r0PqdAwgp+8D1XRLyQkBDd5R7nJu6BxeFAKFszgnrkggeTlJ2+UCZO3ENhuyu4NN2WgWMX8u9lEUwTJHEqsppddxH6atqFF6wgR+5ouNnSsOeCqTiPjmo9soKDHaUWuRwo4mQOV1STY97+FBq3jzEsGOLqa7AUxjzhd5/+16fpm7c+ooHFfkB/Fb+FAwAwH4z9+vnf+n34UtPKPKAt/Tfhr/V8WfmcU/v4cnRXAv6BLNZYDMTwt6DojmjBidKHGnvEUQ5YyZA8zjMf771y1HpgWdswmETHFq06UQ1QLmunAmV9ZozgBjk2gXq/hmtZIsEXXi80wOY15KEz7qLYKf/VYTYRzD4d/Y/34u4HZQstu2zpRUGPOH+2IumS93abaYC7kn4T1kf5PnHbuXgKX1jX1+vtYopCIRHnVltu3+ntiBuisLImASW47uImVsButzM3c9oleRi3KGYscfJ+6NzbjwFik8ZXnwmvxhvtN19XJOgIEQqyVRceFsHkhZXu6FGYxYTPMUlfBIub6zPuk7CzzkcsccbvJv9anLLUpPetWk0yS5A4bgts5rOrzKWFjzd2B8rVp0lBBeV0Pja/NS5syEygoUDiTvm+6NKtgKWrB9LaHr2lOeYDXOZ0cxVZ/Eaunk7tbkXKciwmEj2fzrfn+6q9rv7N7D9GBwW1KJiHPUF+/ktpCBqTyo+JwlSV3jS0pHkPhivVodu91t+AXxppmcUiDkI/sLS7tjdbk1WF/6lM3uD+cV4d9X7f7NE8ZtDIs4OduZ4+Uk2gAJQs5xWxd9wkmtcu2DBgryMfJAmDhEzwwBU0aZR1uq47hwwghTkRScNhijNAomiU9/7SQcLSK8WtJ17Nr4vcR47h415peaI2zStIlQxEdi5oF6zI5r2EGu6Eb8G7UZSE3MHpp1q2/ujZmKEcM5W0MM07jHcFlKE9zOrUv+zrzG43WUjQzrdvMM9Bwwz3ikAQ/uqO4HmSH1Bmgz7IQbEXnWAyrm23j/k9SDZofJmvGDNsMeqLRtqg2TcrZHfsUISvUVovhd5NtNSTKEk1mzb5vuxQr3u8Pzb7v2tQlFGZKXKOuO6Twzsyj6NyLJpn+3uY1dGlz5w5XBWF5AkfFzbPJEg+6q5qZ+UXiZ6ibXNbBKZbP9TYtrNA3vVKerhrtuU4XCPMbNMKAQZOwkJjf4DODm8dJclwG4efKebj0nOxXlvneNLdtGmBo/kfx5HPbZbEg0XxnruW15zRWUagdc1qcIL060UPXb9I0gGk5p905T5FodruKTp+7etXDhfZxesP8A01vz91hlyYibIe/wBnO+wuN4I7MrZkm8kk3wvdvCl6yOMQgIooIX5r+YmPx/o3b+4tLYjryevXfcI4amyP8qy4Zzin3Gr4QHMf0/Zv9Tdb5smi9u5pFN/UpCRpzW5WbZvmaJHu0ZYMabLN2X72N68Vow0SXQfHNxLaLjRA9XbZF2DRdtnXDLIRnlc1L019mdbRTZ+b4XHqSHttmqi+DwsFNu8/tPIoZumyjsvnWpD17PdrsmGUsdlkCMPf31DZ9fzw9ffq0PqxO5bfm+/pruW5e3b+fgFG9X58+wTdLCcBBt1WPidlkcihDqwkeTsskwVKm/TW48IcISzpoDwh9dZ8gj5Pa/Y2mZSK3XlISkFh+mQnIZbKO8L3mGAugBsVDdqGkc5qGKXqIhve5l4nq8kmhGy4c2CyVlE9KosUFRT9R1NvbW7nu6pfD/nkL8tpDIi4th2iGxjPhhSe/f5Y/yqDzaax9TsoeFgrzR63oAd7i3WS7Ox66bO96fz5Nz18EZtor58doJLb71fa8bvdJK0/cjP8us4K6vYff7tftKkNp6Dn8PJvXdn2ut9skH2tsVqjzt/vT5V4cPd+74k8ffmrS7vumO3YXrWe0PzjDKt1ILN5D365zGhfV3VeMZiQ06XYNPR9MI3nuksVlaxrl6Z9MXurA++n/OGVbQow96vPfmvQKyPxR/H2XFubaddu6e0lgupoNtlyFaZZZ0wNleb2Zu22eU15oHsXL+7bZv2QNDoHu3PPrS6i7TuApNap87HI/Mc0ls5VAQ/jhtLPdZvcLzPgwbVmlvkR2bFTtl21aLjEbHx350ssGwRSTXZ3qgZ6J4/uDXd19yzJwdX9HftfU+6wCoi1k1N13Tb85JCqhXTTU3Xfnbd8et0lQM7QYX8ug8FYyLXP/RmXfvNR9+5odzN3ea9w3bylIW7ZqeemeZJ3mc4nlCdT6+0PakMNmF8HEQwl9Dszuz7uv6eUdjplp4jQ+12BKwuHrP5pVmr3QdgAehYcU+2MxM60jZr2bcuUSIJGVeRSR4k572KcRiXLAGaSoGMXpqHOnBwgMDTzEuLkRrxrt2OwhF+3ys3hzu/WOh1N7kTok6m1Xffd4OJ3ar2mSRNmhwX7ZfECRztXM09XtKdtCWXTHgjoJ3ClOsvX9Rx5dszp0WXm8/6DCc0uxOArlcCbPTdfsV80nwE2nTxeIxqKeNcNzd3jNDvowLnEneNW9uua4rVeX1yiw1UD9vmv6c5fdIYPvrJbVu+uY0PNPZ48hqSvtl4crVte+bDIwjBZ2PIwuunSjy03Dgs1jy8v+mxifFOhFTE7N6pC11/TtByCntL2PfnCD2uPU9Beb4NF9mGLpZCYP4u5PLqfmtenqpMWPNh8XcNsknQP0Ch9aqU677OMPhU0NN/Qhdbvb75udjs2qfW6zYEch6PUsdHmtGVMq/UJigcH7uuuz3iN8M3vzlPtDekg4myCXaXbomvL9vO8//jdvsVAU+Czmvjs1/RTj+8ujY5xW7qVfsN3eCDidj+nOYPbDmSkOFx9uofvLq1nf3yFNL02huAdtxF1eHEU1QpNAX7fpmSN6WRt36L7+ln4yOPu5HMYhzdbYTHAWm/TDHCwug6OEuj7DLr3bvex45qO3aIt7vv0ma4rfX6X6TfZhAXpdFXfMdpcmOMx6uPmTwoKeBMpZs6dfjU6K6c7ZTUM0my2+aQgf0J5WXXvMDtXu/9jgvF83z/lHFRT98m9Ze2VSULbwmBPNgWKEbwYKb/9w7ZxvFLGVQjm8mnSpb34/v+GFfoqC7p1f82+kZo9OZjwaLXMTF37ub+++Nl1S7NGd5nVWbynuRW/0ohnurU63lehl9GvXi9+y63Doxnd53Lxt8kOG+ePkuQV8a9NjGyxSFoPDt8M5vXSMtujRbPzWtX2fTbG6H1B+z+5v3nzj7/vhnOSpJT3eKT7/13TZBubGz2G/kOLYHpttu2+Kp89ffv78f/mq6jndZgAA"; \ No newline at end of file diff --git a/docs/api/classes/BunSqliteKeyValue.html b/docs/api/classes/BunSqliteKeyValue.html deleted file mode 100644 index 2cdf46f..0000000 --- a/docs/api/classes/BunSqliteKeyValue.html +++ /dev/null @@ -1,111 +0,0 @@ -BunSqliteKeyValue | Bun SQlite Key Value

Class BunSqliteKeyValue

A super fast key-value store with SQLite that uses bun:sqlite -and v8 as a fast JSON replacement.

-

Properties

hKeys -hVals -

Methods

addTag -clear -close -delete -deleteExpired -deleteTag -deleteTaggedItems -deleteTags -getCount -getCountValid -hDecr -hDelete -hGetValues -hIncr -lIndex -lLen -lPop -lPush -rPop -rPush -setItems -

Properties

hKeys

hKeys: ((key: string) => undefined | string[]) = ...

Alias for hGetFields()

-

hVals

hVals: (<T>(key: string) => undefined | T[]) = ...

Alias for hGetValues()

-

Type declaration

    • <T>(key): undefined | T[]

    • Returns the values contained in the hash stored at key.

      -

      Use hmGet() to read field names and values.

      -

      Do not use the hash functions with several very large amounts of data or blobs. -This is because the entire data record with all fields is always read and written. -It is better to use setValues() and getValues() for large amounts of data.

      -

      Inspired by: https://docs.keydb.dev/docs/commands/#hvals

      -

      Type Parameters

      • T = any

      Parameters

      • key: string

      Returns undefined | T[]

      If the data record (marked with key) does not exist, undefined is returned.

      -

      Example

      import { BunSqliteKeyValue } from "bun-sqlite-key-value"

      const store = new BunSqliteKeyValue()

      store.hmSet("key-1", {
          "field-1": "value-1",
          "field-2": "value-2"
      })
      store.hGetValues("key-1") // --> ["value-1", "value-2"]
-
      - -

Methods

addTag

  • addTag(key, tag): boolean

  • Adds a tag to an item.

    -

    Raises an error if the item key does not exist.

    -

    Parameters

    • key: string
    • tag: string

    Returns boolean

    Returns true if the tag has been added. -Returns false if the tag already exists.

    -

clear

  • clear(): void

  • Delete all items

    -

    Returns void

close

  • close(): void

  • Close database

    -

    Removes .sqlite-shm and .sqlite-wal files

    -

    Returns void

delete

deleteExpired

  • deleteExpired(): void

  • Delete all expired records

    -

    Returns void

deleteTag

  • deleteTag(key, tag): boolean

  • Deletes a tag of an item.

    -

    Parameters

    • key: string
    • tag: string

    Returns boolean

    Returns true if the tag has been deleted. -Returns false if the tag or the item does not exist.

    -

deleteTaggedItems

  • deleteTaggedItems(tag): void

  • Deletes tagged items.

    -

    Parameters

    • tag: string

    Returns void

deleteTags

  • deleteTags(key, tags?): void

  • Deletes multiple tags or all tags of the item.

    -

    Parameters

    • key: string
    • Optionaltags: string[]

      Deletes all tags within the array. -If undefined, all tags of the item are deleted.

      -

    Returns void

getCount

  • getCount(): number

  • Returns the number of all items in the database, including those that have already expired.

    -

    Use getCountValid() if you want to get the number of items that have not yet expired.

    -

    Returns number

getCountValid

  • getCountValid(deleteExpired?): number

  • Returns the number of all valid (non-expired) items in the database.

    -

    Use getCount() if you want the fastet possible method.

    -

    Parameters

    • OptionaldeleteExpired: boolean

    Returns number

hDecr

hDelete

  • hDelete(key, field): undefined | boolean

  • Hash function: Delete a field of the map object.

    -

    Inspired by: https://docs.keydb.dev/docs/commands/#hdel

    -

    Parameters

    • key: string

      The key of the item.

      -
    • field: string

      The name of the field.

      -

    Returns undefined | boolean

      -
    • undefined if the key does not exist.
      • -
    • true if the field existed and was deleted.
      • -
    • false if the field did not exist.
      • -
    -

hGetValues

  • hGetValues<T>(key): undefined | T[]

  • Returns the values contained in the hash stored at key.

    -

    Use hmGet() to read field names and values.

    -

    Do not use the hash functions with several very large amounts of data or blobs. -This is because the entire data record with all fields is always read and written. -It is better to use setValues() and getValues() for large amounts of data.

    -

    Inspired by: https://docs.keydb.dev/docs/commands/#hvals

    -

    Type Parameters

    • T = any

    Parameters

    • key: string

    Returns undefined | T[]

    If the data record (marked with key) does not exist, undefined is returned.

    -

    Example

    import { BunSqliteKeyValue } from "bun-sqlite-key-value"

    const store = new BunSqliteKeyValue()

    store.hmSet("key-1", {
        "field-1": "value-1",
        "field-2": "value-2"
    })
    store.hGetValues("key-1") // --> ["value-1", "value-2"]
-
    - -

hIncr

lIndex

  • lIndex<T>(key, index): undefined | T

  • Returns the element at index in the list stored at key.

    -

    The index is zero-based, so 0 means the first element, 1 the second element and so on. -Negative indices can be used to designate elements starting at the tail of the list. -Here, -1 means the last element, -2 means the penultimate and so forth.

    -

    Inspired by: https://docs.keydb.dev/docs/commands/#lindex

    -

    Type Parameters

    • T = any

    Parameters

    • key: string
    • index: number

    Returns undefined | T

    When the value at key is not a list, an error is returned.

    -

lLen

  • lLen(key): number

  • Returns the length of the list stored at key.

    -

    If key does not exist, it is interpreted as an empty list and 0 is returned. -An error is returned when the value stored at key is not an array. --> Array.isArray()

    -

    Inspired by: https://www.dragonflydb.io/docs/command-reference/lists/llen

    -

    Parameters

    • key: string

    Returns number

    The length of the list at key.

    -

lPop

  • lPop<T>(key, count?): undefined | T | T[]

  • Removes and returns the first element of the list stored at key. -If count is specified, returns count number of elements.

    -

    Inspired by: https://docs.keydb.dev/docs/commands/#lpop

    -

    Type Parameters

    • T = any

    Parameters

    • key: string
    • Optionalcount: number

    Returns undefined | T | T[]

    If count is undefined, it returns the first element of the list stored at key. -If count is a positive number, it returns the first count elements of the list stored at key. -Returns undefined if key was not found or the array is empty.

    -

lPush

rPop

  • rPop<T>(key, count?): undefined | T | T[]

  • Removes and returns the last element of the list stored at key. -If count is specified, returns count number of elements.

    -

    Inspired by: https://docs.keydb.dev/docs/commands/#rpop

    -

    Type Parameters

    • T = any

    Parameters

    • key: string
    • Optionalcount: number

    Returns undefined | T | T[]

    If count is undefined, it returns the last element of the list stored at key. -If count is a positive number, it returns the last count elements of the list stored at key. -Returns undefined if key was not found or the array is empty.

    -

rPush

setItems

  • setItems<T>(items): void

  • Adds a large number of entries to the database and takes only a small fraction -of the time that set() would take individually.

    -

    Type Parameters

    • T = any

    Parameters

    • items: {
          key: undefined | string;
          ttlMs?: TtlMs;
          value: T;
      }[]

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods
diff --git a/docs/api/modules.html b/docs/api/modules.html deleted file mode 100644 index 517f3d4..0000000 --- a/docs/api/modules.html +++ /dev/null @@ -1,2 +0,0 @@ -Bun SQlite Key Value

Bun SQlite Key Value

Index

Classes

BunSqliteKeyValue -

Settings

Member Visibility
diff --git a/docs/api/assets/highlight.css b/docs/assets/highlight.css similarity index 100% rename from docs/api/assets/highlight.css rename to docs/assets/highlight.css diff --git a/docs/api/assets/icons.js b/docs/assets/icons.js similarity index 100% rename from docs/api/assets/icons.js rename to docs/assets/icons.js diff --git a/docs/api/assets/icons.svg b/docs/assets/icons.svg similarity index 100% rename from docs/api/assets/icons.svg rename to docs/assets/icons.svg diff --git a/docs/api/assets/main.js b/docs/assets/main.js similarity index 100% rename from docs/api/assets/main.js rename to docs/assets/main.js diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js new file mode 100644 index 0000000..20f1abd --- /dev/null +++ b/docs/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA43SXW+CMBQG4P9yrsk2XdwHdzjrQlRIEI2LMU1Hz7RZRQZ1gSz+90Xd5EMt3NL3PG9bOv8BhakCE0TIMQUDIqZWYMJ6w7cSk9vD55uVWksw4FOEHMy2AcFKSB5jCOb8BHS34fhLCoUDzKZMbjHHAsmS5ISdBct8q/20M06q7fTIjLoTn7p96lnOK6HE81yPDq0uGeYV3ywW7D3fsX6u3HjfLhVOraHdoy/uxPGbdl0Z0dX4ZEQd16dkZo/9sQYvB6ukcbxcMIFjFGPAFHK43tPwQNeHNEdyXGp5nvXWrONS+gxfFHgRKow/WIDJpVf6v9boqdoK1zmSDxedfaaCdR4K23EjJTZhUsf8xXSSh8Em5nXQMaVz+gJlgVFZVBYO6xXg7vmx1Sn+xAFmGmKAWR0wYilJIxGLcLm/wkSjVaN1tM+WGs1ny1pAyZFuQ4f1y8hit/gFveAXyCwFAAA=" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js new file mode 100644 index 0000000..ec46c3e --- /dev/null +++ b/docs/assets/search.js @@ -0,0 +1 @@ +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA809XZPjtpH/RXm5B5aW+CKAfXNiJ7dlx07ZjitXe64pzYgzo1hfJ1Gz3rj836+6G6AIkE1RM6pKnoQhie5Go9Hf5Pw2O+w+HWfvP/42+2W1Xc7ey2K2XWzq2fvZarusf50Vs9NhPXs/2+yWp3V9fIdX58/NZj0rZg/rxfFYH2fvZ7PfiwhBnUF8+PanL7758OXdn777+7c/3n31/ffffX/3zRd//OqbFuzL4rBa3J8BszMGUBaz/eJQb5uW1kEavv3u7ovvv//ifyahH3r41Zg//PjVX+++/e7Hu6/+8eGHH3+Ytn5+zq3omIr79fi+/fKrf9x99/cf77778933X3z7l68mbv3YtOuoEdK15PzxtP3h/9arpv66/vzTYn2qWwoCrIC/99x1KGWpzziX9bpu6q9+3a8O9fIqfH/Ip45g74MYp+c1hNyKgod1vThcR0CcciP8u+OVDIhTboL/qW7+tDttm+tI6My6KRU/LdarK+Uyn3oTeo5186GpN8frSOnMugkVzz/UV+5LmHEb7H+5Gvtfboh9c/3iN7dc/eb65W9uuf7/Xhz/vKrXV56G7rSbScErFER32s3owIVdeSaTeTejBB94BSXtvNtQ8uUrzOd50m1o+LB9uNJ+xim34sHV+MOUm+Bf/+10fL4Of5xyE/yH6/Efbol//bfd/trl44wbrf5a7IcbYl9/SELRaauPc25DwTf19kr8NOM22K820esbWujFcvnj4uk6/O2cG0YvVxPRnXZbOq60SMm821LyVC9f4UAPTb9VfEFQv64/X0lTPvW29LzGkehPvi1Nr9i43txXU9RJ8zX14XHx0OHOOdcXb40m/GTprTBniF/Xn1tQzed9Cujr+vOlvEpLD4+iqwt6KH5cPN0ARRoU9JDg7degMdU5UdbUmxbD+ekuGnjkjVi+rx92h+UFPPTQLXamWf/1OLI3cPsGaP66+BVTZKvtU3qMehjzJ9/Ize/2zWq3PV5gZ3jqFbhEKfXZ7aoXy912/fkKbH/ozLmENk7k0D8c6kUn7JmAvJ3xVtSwik+H1XXYu5PeSkCTyPEE5HHCWxFvMnn9sP3y/ho6mPnTyfq5CLnt97/NXurDcbXbzt7P5FzN/ayYPVKM//4j0VvMHnabTY35h+Xu4YTDn8NjP9UPze4AD9PT78pZ8bEspJ477X/+ufgYJ+MNvBBhnK/gRDErPopCmblTJpkIN2Qh5t6rQhVyrpwsdCHmTonCFGpupCmqQsyVK2xRziuvC1eouSxF4Qs198YXoqTnUvwiwS8B/yABMhKgKyJAVkRAqZEArRURoAMF1hUiThAq3BG6kPOyEoUwhZxrp1NiZEKMAmKqQpVzK21CjGK4oY3kuEEkuELYQs6tdIVwYaLwNEhJUQkpGhCWQ3zRRKSeW6MKKQo5r5wrpCzM3GiVwtQJTAMw1RBMg+Kj5kLaguN5zmupCzV3VVVIEwfwiChlIS1dSYkxCTEVEOOGeA13cCMrqwoJvDKyUECes1UB4jcX3hYKHjGFUoWaKyBGF7JQsMu+KlQFu21FoWyc5+LAw0JMoSNELcKzWsYrigYp/VVCv50VH7UeYibeITpcoYEQWWhb6LkQutCuMHPlXAraJqAdAPBDoF0EXVlRmLKA8+4KI2DLXAFsmqtKFiAYc1OKwsDmKesKY2AgClPRnBS9S9D7WfHR2CH0ntCreWlUWFmlCJvLmOVTLQNKxwzuNt6C7ZgboWlzKm0L4wo9L40pDAhAqUVRwX5VQhSVAOFXRSXDr8LfTMtkag60TqUHCcBbRTn3wqNwW+vh8NIFCbzVXpBwl06QaMHxhwvgwGgQMWQyMEI6BTSLuZK2qIDtwhcViqOyRWUDuArEsbSmqHwYWNhOLXVh8UwrW1gZB3gW4ezpOADAxtnCVvEZS3AyNqTaVoC+s3KQDRLZIOalV8gGZypavQX0wCDnFa1awwDVmkdhE3PnLK3aWFcAn+dCGVq+FprWX8LABoC4JJiOS8IBcKQyVWF9GLgyDkQcSIKcLTLV4gI0qRvUc3gL91jJoK48qRg4NrizUgcVIWVckhSwANCKghjvhCsc0A02yJlwy1WwA1IUzqJFUAXo5XnlC+fDBV/GgaA7XoZfFW/oOCCzkot1aiUEKHhQdwNL1cFkSelRhytR4b5qGewk3EA5d0bQTisnaKcrgAkLFMYDN8q590HiBZx4EQcapgtQL3BuiBcG1mMDOO9ABGzhPf2KsgSwwMYSoFROFWAyAjmlaq/pdmTaEWl1WYjSttdcO/JxJMpAhhCiHcn2rgqkCN3eBJ3aU4siNZ/CoK8yzG3zH8rtfx+PaTldJttBJqdugUDrL9wgk6vIZEHelyplYLIMvFVBY6sq8tZF3qoq8Na6wFtdBd7CgNweS0y23gUuGx/YrKvA5iqyWbvAZ3AzSay1iiw3LrIcmEIsx2u6HZl2hCwHmojleM21Ix9HxHJ4jliOI9neVZEWYjne9WFVQgJ9rrQZ81OfRlh0vcSgfbD/wcz/97Gc1jbMcjnI8tTXEw5ZPmytXGB5qQ1FGwKiDNgbjaw3xhLr4QKSgAtDtoJdhWeNF+Aql3OvcDPE3AsBe1DOvUPfMQw0blhgfWU0WG+ahUYbAOJmKKVoM6yvaDOk9rQZMKDN0FHjAOm0FzoqHB31jY7qRjgXNkJHbaOjstFR1wBe2gUayXhTRcwSNxq8N4k+MmyRxI0Glkgbp4JKxvUI2VKtSnou26zUMxbg1Qo1HC/DPRcd8Nzv9qD7lEHpJdfc+zCANZFDL5Qc8s5F6kvLEokYlBi8h+fLOROoEJKokOA2ViE0R3qk8kQPBKXex+gUmYcBq9IxkkcHvRKZLMvUyZaYTFCDBlJSPqGcGwiKUFIVyrLyQZYhZIY9tSAtCoNMDTFzSVvqw4AcclUF6QZjCtvplaGIUGiMCcUcNhfl3UCYCRwoS0OuXanCCTAqnAAcwAlQVtMJUKaiE2BKDyegnFcq+N2iCkdB6nAUSiC+FGiWSQvRQmGR8ZpuR/EUkfCXVqHwx7uuHfk4QvmXmuQfTrtB+Y93VaAJtFC8i44r+N+kDSQdCjG3eFBsfE66sDCBXrAFJYJMwxnKBk9GwBNh5ONIl+1ItCMZ52rVXtPtCDUK0Ev6B0ctDt3iABoJimlxmBaHkXGuaXEYkFTldCEMSK8BKk1FdzOZzfJPmIAaDndlDIlABDAkUiGtI0EigVyIWTGdI0tLEmnBzUHFBUod2aGi2ElZaDRBIpg6AEimzgdJglk+QkaliijwTHo4nRj+lyDPBo6ux5GPowr4ZYFMsMHhmsSwRhTgQ4a5lW5Hhp7LuJSGVJIyY8MnG+6hqjG2IlWjYQWVpRxVBjgNYCRlswbdPbw3HXDqrEt01qvBLArew/2Eo4euP/CX4nlFarMMuruUlkK9SplgORyItpHxmsU8UiEg2TSXYHMwbke3yKpwT4dfZDYYRozbS58vInWGJTrDdlg4q5suYoj4HrGFwCAdnvL0iyF6Zq9k6lRKdCrdcI4Xc2XBVtJxpYMmKJusVEW2wFQSFilQZikVA2kSdCmFoHOGYRSaCUgboaKswjkz8ZyZ0hV4RnRMT7gqRPcVxjySiMBEKNqowC5QP5KUahUOISrySgZgwDgyQ8QunIv5Col2TMUZDr0UMHVoQxyqkqq9ZtsRuUH5wUzdR4nuoxsWc9cyl3hbhsSOEMRcESJSA5qS5CQyF7QCMrcMSgxdeWSudpG5gbfSR96qwFtImODajAy8xWoA8jawFnw74iyoRuSsB2+W1BusnTgL5os4e5bDwE18CrlpfBV4SCPbjlyEgZkXCYGGF7TrGV9TT0+ip+cHM2V4D9zF0kCWvJx7TRERnFRkMKwIOATokcHgkpG+N2QlIPRABjvgK/ktNjonIdI3IjBW++CM27IiVwRmWRNQk2dblhVyNLDWx5uUpqzIRkooEaCNDIKMrEXfgXhbkdCGu8hmD8vxZbzmMd0HUuJ1O4JclQU771HQ4A5k6MM11z4XD5Asy3BNYrhAI9mOVKBZYsAA8CR6TXS3ake2Hbl25ONItDhEi4NSMXllQqYetgK3VopBDxvvkcNFm06VnxKLFehWhc33VpKvUIKHg3EXnAlyG8l5QBH3YUAZVhOkIRQqQIZ0oUXQMRSjBVVWgV9q0ACI4HIiTpQGr6IwgJJB304CTk3hkA/avbJRXSnwVvG4WCAJ99Fi/pukAXJWID9whCSaGxphXlTBXUvXsqJWGiEojAKGszt4j5KDVGMrpQpRLzLYKzpdcKowPreWAobKhwQEPEH1PnAgUaHBMw5PhydWwwAdYZhORxFqWTZcoaKSsEHXORGOoqmCjpOeYgCA42XIhVPkCRFDOItIGnpxMig3cPnAO4ZqnQ37gJxGjYkn0lYtxSqC8zKu1Mc1044ozM5X7TVSoFUhZRmvoedP12Q7Uu1It6OWHTIk97M9TD1mhYVZOeiU4D0VShOoj/VATYX2CF0M4IcIxwHmUNziLFQXqa5BvrQPNl54sixWyE6dJBZDHOWaJG5IGCF/HXC/itckpQcUrZgKKhKCRAxCIUc6UElRWakYK8JqsEKL95CVlCFzMoQNJQY3QCxELpbSQ7R4azQtHgakCxStHQyuJk8h5IKVc8G+YuCGNSGwnRUaJVCF6OjTtXiXlgpWkZZqfRbMq9QzV1g/GM514D3cVtCsVAjSoZ5iTEEVytJQpg+0A1UoYYAOkSukgnq1F7m6SJ14RRXrYUVsusXIUIMsJKYsnM7K/Cr1qxUmkiEsG4AL9zAogsC1hVdIVQ1V2FXq7CrMkqrhw2G7kCFEj5CHaU49PYXJQDWsOuFeZEGf9gxu6ukoj3AHPUjV2sXz7NRUajSHoH/nrlJpn0K4JecyP0s6tQoarQJIRb9/pb2nQTVmYFLFpDGUh7MNrphMwcR7UKkVhdRlYcCdygCmZ1xj1GsH4SlqUpBzBU6ijCzXYrANI+vtwKAX3BM/t1qkgKnxQ4d2Aakl9QsUkP6JIz3UQ6DTs6Px7MAB6XuwdA+0MeWVlZLkwxhq74BmDgHKpJI2eDOGFBek0ARmbIJ7UlUUDThI2nt6EvPFVeWgyAuRA9R46deE2pKngq4jE1rFlBlgQTRo4zALBIVlUGdgSqvgl1QuuiWg00K6E0wGaCJvComZJLoUYUjMJNFIhMcw/JWFpLp9IdFBhl8Tfqvwa8OvC7+eflHfZhpMp5pGo6apBisqeA9TRjbYCXD0MJBwoX4C6jdukMKlQ7UEyIVSALVGhBALQvYKCbVQiQZ/Txfo0JFX6AMYYqaFAnTZjrA6hA4ekIpht6S0EV5T7Ui3d017DXLKzhcS8zIVFjUxye2ART6ObNmORDuSNMpYmKpUjSoVfMIBFsI9ZIMGIi10grjcf9GpItWoSO1g6w7eo+SoB7dbQTBFbPYSuKnmFsIUERtsBHEEeGUhRQ6ZRIlZ9tJnVKRqV6PaHU7t4D0ypuQ9GafIgcCKqiuohYzcA+eIQNmWXCrbpnYwjsa99bjdoVfMxu4oaWNXlKSMDoxc2Y5EO5JDHVE6NQYG46bhzgu8x3IWyqd91mLJEhyYC6w1qTkxgtd8eI/KDYb6EwEntbg5UlxeBEUFTUeoqJAsdB6h/gD9Iaj1JTZ1QbAACide83FkynYk4ggZD/0k0lFpBVhraJStKbVtBp1uN5iAxXuonCt/9jclJihaV1JRc4qjbjfIoWLyHLxNY4Jfjt0uurKkUMDdJE2uHTTeyLmHuK+MriUYqeBQVu1dVBU00u3IxJGNREhskVE+30iyv9gn+1IfmnpJ75pBm+us+G12F9pnQZuFrt7ffj83yr7/bSYcXZIi/NrwG697+lVl+A3P6Qp+f++02sKfQFyZIPYVgzgHrA0HUCQAjeYAii7FQ4BkCsi8GtCiC4hlbUVXhArg5AUOh/sqPK959A8P9fEIn+ToUMEuh2fsYrnMgLBrIeIYIMcuDMftT8sHE36r7roZ0A28XdMl0LbQzxPPSAahPDb1IWWVup5V63UXhOakOuxt2FIRJEmErRU6/AYWiCgiYVp7GMv0UCo9QtfuU7I467jF8fK0htcVPnfBWMHtori4a+tPi8+JSEDplYE2lSGCxbaBTw6k6EruKNwA3TbBxOqiDB6jRHtH3nSVazEzI3QkB1dd0kFlqosuMaJVgZd0Vm4V+AO0369XDwt4sSM9i9xJGgF1qBMQleVAsDZqcXiiCx04rIXsLnEY2GHxOTUt42KRa8CcuylXWZTz1bGHWrK4CeggsOT0aO7kVylxOhBrwt+GVwhN6opwCqrnilxg07AQDlFwv8isJZRixtySQSCp1JWcEYlkxUOs/SUG3dcPi9OxTnUYy6U367D7+mG3qY/pMeR2PaokXhXd13V6pCV3pIfV3jDMx112yjVr1yZQ+LRK9bZlN4/VOvd1k/kRgtW6I7xf7+4zY8Vprxts9CldtSmvp/e0fX/EN7cTc8PtBatw709bAvNL/fmFvnzX2dszuBbCNOoS3cd6wG6a0YsMFeHA5l5YawyjI6vfoqfGFMJD6mZAofdabRW+WNfhTsdz9j0mD4PYpUrJdPZJlP2NEqyJedhtj6kVYBUOv9sPu22zWG0zTa648zMG6JSaflbXZgKRbOwg5PDScdcf7/BdT2Q8QkkjM8eJAO/WI5jVNg2gLKezeDjLRbNIVRan4N+usgAXWOtE7FjPLHq1eZjFuNM6kBFdl9YyX3Rhlr1dZbeDVYHL+9Ticsr4sj1b1ouHZvWS08TyiXell/Xj4rRu0qWxHjnHtov6LH6/s+NlnmmdxdM0figIRnr2K9aMjwZWPPg6fuu0Q+nZU6TofiKlu/WyDi+/r+izEN3TzCmtSzxMXXXO4AU5D/sVtVfGExUOqxqRDkCZp2DUWXDPHtwUjjT4uZg+M5TqADTXAcwgiQ4kPRHScfW0zY8Sm0HgDe5ylckmC4Lf4l2qZtkczNvV7C6VJMFZQNWF1JGhS4kMlk31us4Db+jeYVjFeVLswgL4dHGssp7muQ3i2eybNOZ3HAuHo/tBoGlSR7C2WrJqrN42q0MWSbLm881iVG+bwyqVJMf6BlE0xmg/pMkMPW7RxmxkfTjsEv+Xk7Eo2WFzAtxM3gbFfRDtr6vM0WUz6jc/WYA6N5Cslz2+gsxrFGxIL1hXGOGk6lmyuakJfN2vDv3sIZumHpGyARPPWeN4EBL/kgWau9oVl2Nq07tj8Narh1WzTs+DGc+BDEF6XKyzzBJLViuCucixe/y4SIVdjeYOOQh1GotxfjHP/Uf6PlpXXs+SNtP9MhFbaIks0OO4surGW+10G1+y2uxxtU7VLOv58jH44+qQqSY2pmxNFqtsHsG9Tatq7MbxKusxVdHQ7jtekuUN/+Pu0DynmXA22zVCzykzwayjfjkX8HiAKC1VWJ4VbjYV+njYbVImjWcdx4owj6dtjyTBKhXeRkQ46Tlgs4K8XD+lZ58NPaMGlqx0P9VNL63T0XQBwlSNEqG90H8Y6FAoOyCHFMvYUtkAqJNXU9Oi4RbaL/XnDFhH9al+NnUU2Ev4umgXXLfgPi3+faqbPiDB1pV46XhOK1NCsq0F0bWeXGB4XhwTbeHfmoUfTxoPk/CSGGbL6gaeQUv8rHnXuHdESU6LgJ/72RnRTRbLvpgPgqmzgg1bweL173OmD+DbMefjNi018DykCUQ3MyCmZWEB0IC172YrZD8JzkEaOBGqszjZV0+DkJ4XxwFvp0OSmKY/nlfbXHK61ExL6zxv8v2SXTb3tcXYWd8c873vVhumKbLnDIbvis/E09A0++P7d++Wu4fj/Jf68/J+vqxf8M93MHOxXR7fwVerkww1Z7dY52AamucMj2BTvCNqZhqmfrgmFKuQ3rqs3jFntS/rykzEBGKeVgkF2y6S1vXegDS3yUKxuUDWn5mIap3W3oViO614pTsNU/+ss6jsW1HlqkCyksgGlhNR9ZTOeOvYGzC9LNaZQ8RmPXklOQnVmjAksRDrfL1RLNZ7+N8a3YCJFfU3SsV6f0pdNvhGxLVNHNNQHfJFeZZ9b9SEh96i2Ciaz/lGVJ8+fZovD4un3fZxDfhWuwRdKhBsj87FZqrVYxJjvSKt2qvX5o1fTNfhte2TfOJhtdnvDunJZ/uL+OOYNhWxduXicv0w+Zfrqqvtw/q0zPKOFdvNMLKQTGF0SnwDfR55dnwc7t3u1NztHu8Oi+1TfYd5+bv14j71bLou7DQ/HydmwarkVOooiauHDAxbeOO1JYB5WS1Pi3WasvWsPWFD09X2cXfY9HPdkqNqbHHHXrKbfX/iP7JLillVUy+yFxe43CMP5Py/Rrpi2OlLUNPiRIS0zTdeajb7P07T/pC3OUi2zZwvJa62vdQVmw9N0oZjNbUA9A7Da+4kdyPAafxLexpeY0+uKmRe280+qoBTG8L26b2VwvQlqVHLhv/IpesldSoh/bA+cjI3pbE5hM8lA6K77a65Gyj0dczHtKg7A8bKVieeH1gLf7DylCv7BlDaMpNbbhXYr2In1MVC3j+PqRZnKxysd/dLneiVToA30wO2OQrWRJfq0pspOgoea676CWjWtWTXuF4cnpLkIRtFTH2B5XLvwnqRF+pZz/tiN8i6fkxhsblcPjRZ19unJgtw2Fgqf4WOtQP9WBC+kHNO9PVN3IjhXee9DWy95nbGfr16ybocWVPPszbLksCXqs56ZFoOtx/odgydnFYY6YewVcfdkNP83nWWspDdPKmaZnI3i2Qt/q3vmvR8QVYfbhaHX7IeFdZR4s/uZvEr31vZ6Xk5t4FMag3Jwa62Wc9up7nprPMvsfrX1ea0SSlk3z+9aE822etebJfhBFD1IivgskUwXvNt6uZ5l+wn21QQjegIRav1enWsH3bbtOYi2Qadyz7rJn+PiM0lXn6zfXNaN6v9Om1O55Ybj0Z2ZPhXeRFKsmq2oYLlIDyepZ7Z05XEbYPA6qdFk6vf8vquim2dvKEsWJZxL/7x3u62/jVVhmx0y1uH7e4OX6Nknc6uop905repz8e2cfL9B9tdVr7kODbrhkOtu3pttPFK5/ByT+L2tLlP24SqSy0e+UscOVGXFdvu/p/1Q1oHfGsL7HQDt3tM9TODmMuEvsq97ezgK19F64V9l5m8XtapNygrtluX1ahZKxK7T5dTjbttqpY5NcUm7OkfVXbsGOsUqZRHfHvkbp/5naxDn75MPQyr13AlO2+xhnebMqhsySXtu2PfxbsyJchmLyYnFXanTJ2PHx9eHPaLVdqdyLYf8ZHtvt6Cwd/0Xg4Zl9JhUIdV6iZJ9hMil32a/e64yg2zYBvvL3cq7nfH4+o+9Wsc29TKqoT9YQffpUl1wvhbboNgenU+Nh2faLshWIfFKnvzn00sBFAdg8oCzJzTCzLK8gsLIumBfq24H7J8uGA9hmvP8mXNdP4vv92VdFovWwU57jV1/mVuN+TqFoamheqH8F+mu+zoZiT7KckbpJMIaZrK5iwIq5YP9WN9qLcP9TtItRzf9RMXnITwGaAezDx/wArwmLhtdi9ZQzpbXYgu00U1dKj368VD7/Uwtk+CP/V1czrk74mz+jYvw17OSRH8dPmsXrlU/L3koeWJ+Zjyi/Ekz87V03OWrmNL3Dwrs69LsZvBV7V63RSum/SaqBv6RqHboTqtO5AyC6nDeX2P6rHO8glcNMvLT96lyGZM4p5fbOw/1k0vEdbVnGJaQ+dxuHP7+s+GHOuX+rBIw2j2gzlvV77H5yTBxr71xr8cc9xkX3hzbMjI+gbH9PVdtvQ/Ilv7+mH1uMo0F/tFvcsqNQLMnLLxjxeMhX0D34Lhlpl9emxk95rFdrk4ZN+7YF3/MTiHvHRuxjOHLJj8XT72kxcjm9lkqUc1asjGObQ71PNzG/l//W9eFhRsC/JFqNBtOQTw+vZEBJi1prNNUa+qyQ9iPe3TFBPbt8xauWaRRT+SrdPydq73qcpOXUYPvH3Uy6KxK6SXc9IiK+u0xVhhsp/Q/4oCa9FG1r5K27nYr1rx56VZ/JLsAfuJNl4DA4jUBrLix8N4zj6+xPbT8Wmt5jn95h1bEo86MjqJWWqJ18PNc/ru0C26MP9ducfR1pM8z/aaz880vXeT2Cz02J6mjUqs0zbG8muDb9ZINc/Zt7nY5Cvf9dms0oIT2+Wcf0+JN8FN4gKx6c5c3nshWN6Fchnx4ZS95c46rXIYR1rMGEt4NE2q61j/bITcZp1VrXX3jfV8ueNee/N5Xx8fDqt91tB8/YfRTttl/dj7whr7maHx+tEwgiYzFGynDH8ST3v4HFfKPv4zG/xi0wPEttfGM5uryzdHLaf8E97l+EdJi+B8jKm6U5adZL+Ox3L3xSXJl6t9qf4r02whhV3FS/6FSPYD0mEzquE9GU/txK62KY2eA2ExK3Lcx5QVm/d7qdMP3whWEt4udZ/SsJyNBflY+dMiTdCx7+HkR4Y3Z5+yN71Zqqarmk/Pee50/COa13zM+tNqnZkAVnmw7u6nVdrtx3r0jGxf9B3YE/ppd0pfIPZsZob1knuJesE2hrSER6eWF6zDqmmyFxrZ3vepnzC/7Dt8zj5CMf4ezyCE3SmBwPJz8oH4V33Isknjn5vuwfi5mO1X+3q92taz9x9//v33/wd9OtT+X6kAAA=="; \ No newline at end of file diff --git a/docs/api/assets/style.css b/docs/assets/style.css similarity index 100% rename from docs/api/assets/style.css rename to docs/assets/style.css diff --git a/docs/classes/index.BunSqliteKeyValue.html b/docs/classes/index.BunSqliteKeyValue.html new file mode 100644 index 0000000..cebd306 --- /dev/null +++ b/docs/classes/index.BunSqliteKeyValue.html @@ -0,0 +1,143 @@ +BunSqliteKeyValue | Bun SQlite Key Value

Class BunSqliteKeyValue

A super fast key-value store with SQLite that uses bun:sqlite +and v8 as a fast JSON replacement.

+

Hash (Map Object)

hDecr +hDelete +hGet +hGetCount +hGetFields +hGetValues +hHasField +hIncr +hmGet +hmSet +hSet +

List (Array Object)

lIndex +lLen +lPop +lPush +lSet +rPop +rPush +

Other

clear +close +delete +deleteExpired +getCount +getCountValid +setItems +

Tags (Labels)

addTag +deleteTag +deleteTaggedItems +deleteTags +getTaggedItems +getTaggedKeys +getTaggedValues +

Hash (Map Object)

hDecr

hDelete

  • hDelete(key: string, field: string): undefined | boolean

  • Hash function: Deletes a field of the map object.

    +

    Inspired by: https://docs.keydb.dev/docs/commands/#hdel

    +

    Parameters

    • key: string

      The key of the item.

      +
    • field: string

      The name of the field.

      +

    Returns undefined | boolean

      +
    • undefined if the key does not exist.
      • +
    • true if the field existed and was deleted.
      • +
    • false if the field did not exist.
      • +
    +

hGet

  • hGet<T>(key: string, field: string): undefined | T

  • Hash (Map Object) - Read Value

    +

    Do not use it with several very large amounts of data or blobs. +This is because the entire data record with all fields is always read and written.

    +

    Inspired by: https://docs.keydb.dev/docs/commands/#hget

    +

    Type Parameters

    • T = any

    Parameters

    • key: string
    • field: string

    Returns undefined | T

hGetCount

hGetFields

hGetValues

  • hGetValues<T>(key: string): undefined | T[]

  • Returns the values contained in the hash stored at key.

    +

    Use hmGet() to read field names and values.

    +

    Do not use the hash functions with several very large amounts of data or blobs. +This is because the entire data record with all fields is always read and written. +It is better to use setValues() and getValues() for large amounts of data.

    +

    Inspired by: https://docs.keydb.dev/docs/commands/#hvals

    +

    Type Parameters

    • T = any

    Parameters

    • key: string

    Returns undefined | T[]

    If the data record (marked with key) does not exist, undefined is returned.

    +

    Example

    import { BunSqliteKeyValue } from "bun-sqlite-key-value"

    const store = new BunSqliteKeyValue()

    store.hmSet("key-1", {
        "field-1": "value-1",
        "field-2": "value-2"
    })
    store.hGetValues("key-1") // --> ["value-1", "value-2"]
+
    + +

hHasField

  • hHasField(key: string, field: string): undefined | boolean

  • Hash (Map Object) - Has Field

    +

    Returns if field is an existing field in the hash stored at key.

    +

    Do not use it with several very large amounts of data or blobs. +This is because the entire data record with all fields is always read.

    +

    Inspired by: https://docs.keydb.dev/docs/commands/#hexists

    +

    Parameters

    • key: string
    • field: string

    Returns undefined | boolean

hIncr

hmGet

  • hmGet<T>(key: string, fields?: string[]): undefined | {
        [field: Field]: T | undefined;
    }

  • Hash (Map Object) - Read Multiple Values

    +

    Do not use it with several very large amounts of data or blobs. +This is because the entire data record with all fields is always read and written.

    +

    Inspired by: https://docs.keydb.dev/docs/commands/#hmget

    +

    Type Parameters

    • T = any

    Parameters

    • key: string
    • Optionalfields: string[]

    Returns undefined | {
        [field: Field]: T | undefined;
    }

hmSet

  • hmSet<T>(key: string, fields: {
        [field: Field]: T;
    }, ttlMs?: TtlMs): void

  • Hash (Map Object) - Write Multiple Values

    +

    Do not use it with several very large amounts of data or blobs. +This is because the entire data record with all fields is always read and written.

    +

    Inspired by: https://docs.keydb.dev/docs/commands/#hmset

    +

    Type Parameters

    • T = any

    Parameters

    • key: string
    • fields: {
          [field: Field]: T;
      }
    • OptionalttlMs: TtlMs

    Returns void

hSet

  • hSet<T>(key: string, field: string, value: T, ttlMs?: TtlMs): boolean

  • Hash (Map Object) - Write Value

    +

    Do not use it with several very large amounts of data or blobs. +This is because the entire data record with all fields is always read and written.

    +

    Inspired by: https://docs.keydb.dev/docs/commands/#hset

    +

    Type Parameters

    • T = any

    Parameters

    • key: string
    • field: string
    • value: T
    • OptionalttlMs: TtlMs

    Returns boolean

List (Array Object)

lIndex

  • lIndex<T>(key: string, index: number): undefined | T

  • Returns the element at index in the list stored at key.

    +

    The index is zero-based, so 0 means the first element, 1 the second element and so on. +Negative indices can be used to designate elements starting at the tail of the list. +Here, -1 means the last element, -2 means the penultimate and so forth.

    +

    Inspired by: https://docs.keydb.dev/docs/commands/#lindex

    +

    Type Parameters

    • T = any

    Parameters

    • key: string
    • index: number

    Returns undefined | T

    When the value at key is not a list, an error is returned.

    +

lLen

  • lLen(key: string): number

  • Returns the length of the list stored at key.

    +

    If key does not exist, it is interpreted as an empty list and 0 is returned. +An error is returned when the value stored at key is not an array. --> Array.isArray()

    +

    Inspired by: https://www.dragonflydb.io/docs/command-reference/lists/llen

    +

    Parameters

    • key: string

    Returns number

    The length of the list at key.

    +

lPop

  • lPop<T>(key: string, count?: number): undefined | T | T[]

  • Removes and returns the first element of the list stored at key. +If count is specified, returns count number of elements.

    +

    Inspired by: https://docs.keydb.dev/docs/commands/#lpop

    +

    Type Parameters

    • T = any

    Parameters

    • key: string
    • Optionalcount: number

    Returns undefined | T | T[]

    If count is undefined, it returns the first element of the list stored at key. +If count is a positive number, it returns the first count elements of the list stored at key. +Returns undefined if key was not found or the array is empty.

    +

lPush

lSet

  • lSet<T>(key: string, index: number, value: T): true

  • Updates the list element at index to value.

    +

    For more information on the index argument, see lIndex().

    +

    An error is returned if the key does not exist. +An error is returned when the value stored at key is not an array. +An error is returned for out of range indexes.

    +

    Inspired by: https://www.dragonflydb.io/docs/command-reference/lists/lset

    +

    Type Parameters

    • T = any

    Parameters

    • key: string
    • index: number
    • value: T

    Returns true

    true if the key exists and the value has been set.

    +

rPop

  • rPop<T>(key: string, count?: number): undefined | T | T[]

  • Removes and returns the last element of the list stored at key. +If count is specified, returns count number of elements.

    +

    Inspired by: https://docs.keydb.dev/docs/commands/#rpop

    +

    Type Parameters

    • T = any

    Parameters

    • key: string
    • Optionalcount: number

    Returns undefined | T | T[]

    If count is undefined, it returns the last element of the list stored at key. +If count is a positive number, it returns the last count elements of the list stored at key. +Returns undefined if key was not found or the array is empty.

    +

rPush

Other

clear

  • clear(): void

  • Deletes all items

    +

    Returns void

close

  • close(): void

  • Close database

    +

    Removes .sqlite-shm and .sqlite-wal files

    +

    Returns void

delete

deleteExpired

  • deleteExpired(): void

  • Deletes all expired records.

    +

    Returns void

getCount

  • getCount(): number

  • Returns the number of all items in the database, including those that have already expired.

    +

    Use getCountValid() if you want to get the number of items that have not yet expired.

    +

    Returns number

getCountValid

  • getCountValid(deleteExpired?: boolean): number

  • Returns the number of all valid (non-expired) items in the database.

    +

    Use getCount() if you want the fastet possible method.

    +

    Parameters

    • OptionaldeleteExpired: boolean

    Returns number

setItems

  • setItems<T>(items: {
        key: undefined | string;
        ttlMs?: TtlMs;
        value: T;
    }[]): void

  • Adds a large number of entries to the database and takes only a small fraction +of the time that set() would take individually.

    +

    Type Parameters

    • T = any

    Parameters

    • items: {
          key: undefined | string;
          ttlMs?: TtlMs;
          value: T;
      }[]

    Returns void

Tags (Labels)

addTag

  • addTag(key: string, tag: string): boolean

  • Adds a tag to an item.

    +

    Raises an error if the item key does not exist.

    +

    Parameters

    • key: string
    • tag: string

    Returns boolean

    Returns true if the tag has been added. +Returns false if the tag already exists.

    +

deleteTag

  • deleteTag(key: string, tag: string): boolean

  • Deletes a tag of an item.

    +

    Parameters

    • key: string
    • tag: string

    Returns boolean

    Returns true if the tag has been deleted. +Returns false if the tag or the item does not exist.

    +

deleteTaggedItems

  • deleteTaggedItems(tag: string): void

  • Deletes tagged items.

    +

    Parameters

    • tag: string

    Returns void

deleteTags

  • deleteTags(key: string, tags?: string[]): void

  • Deletes multiple tags or all tags of the item.

    +

    Parameters

    • key: string
    • Optionaltags: string[]

      Deletes all tags within the array. +If undefined, all tags of the item are deleted.

      +

    Returns void

getTaggedItems

  • getTaggedItems<T>(tag: string): undefined | Item<T>[]

  • Returns tagged items.

    +

    Type Parameters

    • T

    Parameters

    • tag: string

    Returns undefined | Item<T>[]

getTaggedKeys

  • getTaggedKeys(tag: string): undefined | string[]

  • Returns tagged keys.

    +

    Parameters

    • tag: string

    Returns undefined | string[]

getTaggedValues

  • getTaggedValues<T>(tag: string): undefined | (undefined | T)[]

  • Returns tagged values.

    +

    Type Parameters

    • T = any

    Parameters

    • tag: string

    Returns undefined | (undefined | T)[]

Settings

Member Visibility

On This Page

Hash (Map Object)
List (Array Object)
Other
Tags (Labels)
diff --git a/docs/api/index.html b/docs/index.html similarity index 99% rename from docs/api/index.html rename to docs/index.html index a2b508a..f4ca1a9 100644 --- a/docs/api/index.html +++ b/docs/index.html @@ -107,6 +107,7 @@
  • rPop() --> Returns elements at the end of the list and removes them.
  • lIndex() --> Returns the element at the specified index of the list.
  • lLen() --> Returns the length of the list.
    • +
  • lSet() --> Updates the element at the specified index of the list.
  • Tags (Labels) @@ -151,7 +152,7 @@

    readwrite?: boolean: Open the database as read-write (default: true).

    ttlMs?: boolean: -Default time span in milliseconds before an entry +Default time span in milliseconds before an item written to the DB becomes invalid and is marked for deletion.

    maxExpiringItemsInDb?: number: Default value that specifies the maximum number of @@ -222,7 +223,7 @@ A search for "language:" would return all languages.

    string[]: Array with keys. The returned array is exactly the same size as the passed array. -Entries that are not found are returned as undefined. +Items that are not found are returned as undefined. Only exact matches with the keys are returned.

    Example

    import { BunSqliteKeyValue } from "bun-sqlite-key-value"

    const store = new BunSqliteKeyValue()

    store.set("language:de", "German")
    store.set("language:en", "English")
    store.set("language:it", "Italian")

    store.getValues() // --> [ "German", "English", "Italian" ]
    store.getValues("language:") // --> [ "German", "English", "Italian" ]

    store.values // --> [ "German", "English", "Italian" ]
    @@ -256,7 +257,7 @@ A search for "language:" would return all languages.

    string[]: Array with keys. The returned array is exactly the same size as the passed array. -Entries that are not found are returned as undefined. +Items that are not found are returned as undefined. Only exact matches with the keys are returned.

    Example

    import { BunSqliteKeyValue } from "bun-sqlite-key-value"

    const store = new BunSqliteKeyValue()

    store.set("language:de", "German")
    store.set("language:en", "English")
    store.set("language:it", "Italian")

    store.getItems("language:") // --> [
    //     {key: "language:de", value: "German"},
    //     {key: "language:en", value: "English"},
    //     {key: "language:it", value: "Italian"}
    // ]

    store.items // --> [
    //     {key: "language:de", value: "German"},
    //     {key: "language:en", value: "English"},
    //     {key: "language:it", value: "Italian"}
    // ]
    @@ -302,8 +303,8 @@

    Deletes all items if no parameter was passed.

    -

    key: string: Deletes the entry whose key was passed as a string.

    -

    keys: string[]: Deletes the entries whose keys were passed in an array.

    +

    key: string: Deletes the item whose key was passed as a string.

    +

    keys: string[]: Deletes the items whose keys were passed in an array.

    Example

    import { BunSqliteKeyValue } from "bun-sqlite-key-value"

    const store = new BunSqliteKeyValue()

    // Delete all items
    store.delete()
    store.clear()

    // Delete one item
    store.delete("myKey")
    delete store.data.myKey

    // Delete multiple items
    store.delete(["key1", "key2"])
    @@ -311,10 +312,10 @@

    Deletes all expired items. -These are entries whose TTL (Time to live) has expired. -These entries are not deleted continuously, +These are items whose TTL (Time to live) has expired. +These items are not deleted continuously, but only when they are accessed directly or when the database is opened. -If you want to delete the expired entries in between, +If you want to delete the expired items in between, you can do this with deleteExpired().

    Delete Old Expiring Items

    deleteOldExpiringItems(maxExpiringItemsInDb?: number)
    @@ -329,7 +330,7 @@

    Returns the number of all items, including those that have already expired. -The fact that possibly expired entries are also counted is for reasons of speed. +The fact that possibly expired items are also counted is for reasons of speed. Use getCountValid() if you want to get the number of items that have not yet expired. If you do not use ttlMs (time to live), getCount() is faster than getCountValid().

    Example

    import { BunSqliteKeyValue } from "bun-sqlite-key-value"

    const store = new BunSqliteKeyValue()

    store.set("my-key1", "my-value1")
    store.set("my-key2", "my-value2")

    store.getCount() // --> 2
    store.length // --> 2
@@ -340,10 +341,10 @@
 
 
    Returns the number of valid (non-expired) items.
 Can also delete the expired items.
    
-
    deleteExpired
    If true is passed, the expired entries are deleted first
-before the entries are counted.
    
+
    deleteExpired
    If true is passed, the expired items are deleted first
+before the items are counted.
    
 
    If the parameter is not specified or false is passed,
-then only the entries that have no expiration date or
+then only the items that have no expiration date or
 whose expiration date is in the future are counted.
    
 
    Example
    import { BunSqliteKeyValue } from "bun-sqlite-key-value"

    const store = new BunSqliteKeyValue()

    store.set("my-key1", "my-value1")
    store.set("my-key2", "my-value2", 100)

    store.getCountValid() // --> 2

    await Bun.sleep(500)
    store.getCountValid() // --> 1
 
    
@@ -642,4 +643,4 @@
 And if you speak German, here is my business homepage:
 GP-Softwaretechnik
 Maybe you will find something interesting for you there. 😃
    
-
    Settings
    Member Visibility
    On This Page
    Bun SQLite Key Value
    
+
    Settings
    Member Visibility
    On This Page
    Bun SQLite Key Value
    
diff --git a/docs/interfaces/interfaces.Item.html b/docs/interfaces/interfaces.Item.html
new file mode 100644
index 0000000..8fe9e01
--- /dev/null
+++ b/docs/interfaces/interfaces.Item.html
@@ -0,0 +1,2 @@
+Item | Bun SQlite Key Value
    Interface Item<T>
    Key value pair
    
+
     
    Type Parameters
    • T
     
    Settings
    Member Visibility
    
diff --git a/docs/interfaces/interfaces.Options.html b/docs/interfaces/interfaces.Options.html
new file mode 100644
index 0000000..0c4a47e
--- /dev/null
+++ b/docs/interfaces/interfaces.Options.html
@@ -0,0 +1,16 @@
+Options | Bun SQlite Key Value
    Interface Options
    Database options
    
+
    interface Options { 
        create?: boolean; 
        maxExpiringItemsInDb?: MaxExpiringItems; 
        readonly?: boolean; 
        readwrite?: boolean; 
        ttlMs?: TtlMs; 
    }
    Properties
    create?
+maxExpiringItemsInDb?
+readonly?
+readwrite?
+ttlMs?
+
     Properties
    Optionalcreate
    create?: boolean
    Allow creating a new database (default: true).
+If the database folder does not exist, it will be created.
    
+
    OptionalmaxExpiringItemsInDb
    maxExpiringItemsInDb?: MaxExpiringItems
    Default value that specifies the maximum number of
+expiring items that may be in the database.
+Is used by the deleteOldExpiringItems() method as default value.
    
+
    Optionalreadonly
    readonly?: boolean
    Open the database as read-only (default: false).
    
+
    Optionalreadwrite
    readwrite?: boolean
    Open the database as read-write (default: true).
    
+
    OptionalttlMs
    ttlMs?: TtlMs
    Default TTL milliseconds.
+Standard time period in milliseconds before an entry written to the DB becomes invalid.
    
+
    Settings
    Member Visibility
    On This Page
    Properties
    
diff --git a/docs/interfaces/interfaces.Record.html b/docs/interfaces/interfaces.Record.html
new file mode 100644
index 0000000..8791871
--- /dev/null
+++ b/docs/interfaces/interfaces.Record.html
@@ -0,0 +1,2 @@
+Record | Bun SQlite Key Value
    Interface Record
    Table row (internally used)
    
+
    Settings
    Member Visibility
    
diff --git a/docs/modules/index.html b/docs/modules/index.html
new file mode 100644
index 0000000..65cfa3a
--- /dev/null
+++ b/docs/modules/index.html
@@ -0,0 +1,7 @@
+index | Bun SQlite Key Value
    Module index
    Index
    Classes
    BunSqliteKeyValue
+
    Variables
    INDEX_OUT_OF_RANGE_ERROR_LABEL
+INVALID_COUNT_ERROR_LABEL
+ITEM_NOT_EXISTS
+ITEM_NOT_EXISTS_ERROR_LABEL
+NO_ARRAY_ERROR_LABEL
+
    Settings
    Member Visibility
    
diff --git a/docs/modules/interfaces.html b/docs/modules/interfaces.html
new file mode 100644
index 0000000..1878ff4
--- /dev/null
+++ b/docs/modules/interfaces.html
@@ -0,0 +1,9 @@
+interfaces | Bun SQlite Key Value
    Module interfaces
    Index
    Interfaces
    Item
+Options
+Record
+
    Type Aliases
    Field
+Key
+MaxExpiringItems
+Tag
+TtlMs
+
    Settings
    Member Visibility
    
diff --git a/docs/types/interfaces.Field.html b/docs/types/interfaces.Field.html
new file mode 100644
index 0000000..4a10342
--- /dev/null
+++ b/docs/types/interfaces.Field.html
@@ -0,0 +1,2 @@
+Field | Bun SQlite Key Value
    Type Alias Field
    Field: string
    Field Name
    
+
    Settings
    Member Visibility
    
diff --git a/docs/types/interfaces.Key.html b/docs/types/interfaces.Key.html
new file mode 100644
index 0000000..72511f0
--- /dev/null
+++ b/docs/types/interfaces.Key.html
@@ -0,0 +1,2 @@
+Key | Bun SQlite Key Value
    Type Alias Key
    Key: string
    Key
    
+
    Settings
    Member Visibility
    
diff --git a/docs/types/interfaces.MaxExpiringItems.html b/docs/types/interfaces.MaxExpiringItems.html
new file mode 100644
index 0000000..93ffcb7
--- /dev/null
+++ b/docs/types/interfaces.MaxExpiringItems.html
@@ -0,0 +1,5 @@
+MaxExpiringItems | Bun SQlite Key Value
    Type Alias MaxExpiringItems
    MaxExpiringItems: number | undefined
    Specifies the maximum number of expiring entries that may be in the database.
    
+
    If there are more expiring items in the database than MaxExpiringItems,
+the oldest items are deleted until there are only MaxExpiringItems items
+with an expiration date in the database.
    
+
    Settings
    Member Visibility
    
diff --git a/docs/types/interfaces.Tag.html b/docs/types/interfaces.Tag.html
new file mode 100644
index 0000000..5662f45
--- /dev/null
+++ b/docs/types/interfaces.Tag.html
@@ -0,0 +1,2 @@
+Tag | Bun SQlite Key Value
    Type Alias Tag
    Tag: string
    Tag
    
+
    Settings
    Member Visibility
    
diff --git a/docs/types/interfaces.TtlMs.html b/docs/types/interfaces.TtlMs.html
new file mode 100644
index 0000000..701af55
--- /dev/null
+++ b/docs/types/interfaces.TtlMs.html
@@ -0,0 +1,6 @@
+TtlMs | Bun SQlite Key Value
    Type Alias TtlMs
    TtlMs: number | undefined
    Time period in milliseconds before an entry written to the DB becomes invalid.
    
+
    "Time to live" in milliseconds. After this time,
+the item becomes invalid and is deleted from the database
+the next time it is accessed or when the application is started.
+Set the value to 0 if you want to explicitly deactivate the process.
    
+
    Settings
    Member Visibility
    
diff --git a/docs/variables/index.INDEX_OUT_OF_RANGE_ERROR_LABEL.html b/docs/variables/index.INDEX_OUT_OF_RANGE_ERROR_LABEL.html
new file mode 100644
index 0000000..d922bf0
--- /dev/null
+++ b/docs/variables/index.INDEX_OUT_OF_RANGE_ERROR_LABEL.html
@@ -0,0 +1,2 @@
+INDEX_OUT_OF_RANGE_ERROR_LABEL | Bun SQlite Key Value
    Variable INDEX_OUT_OF_RANGE_ERROR_LABELConst
    INDEX_OUT_OF_RANGE_ERROR_LABEL: string = "[INDEX_OUT_OF_RANGE]"
    This error is raises if the index is out of range.
    
+
    Settings
    Member Visibility
    
diff --git a/docs/variables/index.INVALID_COUNT_ERROR_LABEL.html b/docs/variables/index.INVALID_COUNT_ERROR_LABEL.html
new file mode 100644
index 0000000..0cd5fd6
--- /dev/null
+++ b/docs/variables/index.INVALID_COUNT_ERROR_LABEL.html
@@ -0,0 +1,2 @@
+INVALID_COUNT_ERROR_LABEL | Bun SQlite Key Value
    Variable INVALID_COUNT_ERROR_LABELConst
    INVALID_COUNT_ERROR_LABEL: string = "[INVALID_COUNT_ERROR]"
    This error is raised if the count argument is invalid.
    
+
    Settings
    Member Visibility
    
diff --git a/docs/variables/index.ITEM_NOT_EXISTS.html b/docs/variables/index.ITEM_NOT_EXISTS.html
new file mode 100644
index 0000000..0f94428
--- /dev/null
+++ b/docs/variables/index.ITEM_NOT_EXISTS.html
@@ -0,0 +1,2 @@
+ITEM_NOT_EXISTS | Bun SQlite Key Value
    Variable ITEM_NOT_EXISTSConst
    ITEM_NOT_EXISTS: string = ITEM_NOT_EXISTS_ERROR_LABEL
    Deprecated
    Use ITEM_NOT_EXISTS_ERROR_LABEL instead.
    
+
    Settings
    Member Visibility
    
diff --git a/docs/variables/index.ITEM_NOT_EXISTS_ERROR_LABEL.html b/docs/variables/index.ITEM_NOT_EXISTS_ERROR_LABEL.html
new file mode 100644
index 0000000..76871b1
--- /dev/null
+++ b/docs/variables/index.ITEM_NOT_EXISTS_ERROR_LABEL.html
@@ -0,0 +1,2 @@
+ITEM_NOT_EXISTS_ERROR_LABEL | Bun SQlite Key Value
    Variable ITEM_NOT_EXISTS_ERROR_LABELConst
    ITEM_NOT_EXISTS_ERROR_LABEL: string = "[ITEM_NOT_EXISTS]"
    This error is raised if the item does not exist.
    
+
    Settings
    Member Visibility
    
diff --git a/docs/variables/index.NO_ARRAY_ERROR_LABEL.html b/docs/variables/index.NO_ARRAY_ERROR_LABEL.html
new file mode 100644
index 0000000..f92884f
--- /dev/null
+++ b/docs/variables/index.NO_ARRAY_ERROR_LABEL.html
@@ -0,0 +1,2 @@
+NO_ARRAY_ERROR_LABEL | Bun SQlite Key Value
    Variable NO_ARRAY_ERROR_LABELConst
    NO_ARRAY_ERROR_LABEL: string = "[NO_ARRAY_ERROR]"
    This error is raised if the value is not an array.
    
+
    Settings
    Member Visibility
    
diff --git a/package.json b/package.json
index 67f4919..cce94d4 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "bun-sqlite-key-value",
-  "version": "1.11.3",
+  "version": "1.12.0",
   "author": {
     "name": "Gerold Penz",
     "email": "gerold@gp-softwaretechnik.at",
diff --git a/src/index.ts b/src/index.ts
index f94e647..ed0c316 100644
--- a/src/index.ts
+++ b/src/index.ts
@@ -7,9 +7,7 @@ import type {
 } from "./interfaces.ts"
 
 
-/**
- * Internally used database options
- */
+// Internally used database options
 interface DbOptions extends Omit {
     strict: boolean
 }
@@ -18,9 +16,26 @@ interface DbOptions extends Omit {
 const MIN_UTF8_CHAR: string = String.fromCodePoint(1)
 const MAX_UTF8_CHAR: string = String.fromCodePoint(1_114_111)
 
+/**
+ * This error is raised if the `count` argument is invalid.
+ */
 export const INVALID_COUNT_ERROR_LABEL: string = "[INVALID_COUNT_ERROR]"
+/**
+ * This error is raised if the value is not an array.
+ */
 export const NO_ARRAY_ERROR_LABEL: string = "[NO_ARRAY_ERROR]"
-export const ITEM_NOT_EXISTS: string = "[ITEM_NOT_EXISTS]"
+/**
+ * This error is raised if the item does not exist.
+ */
+export const ITEM_NOT_EXISTS_ERROR_LABEL: string = "[ITEM_NOT_EXISTS]"
+/**
+ * @deprecated Use ITEM_NOT_EXISTS_ERROR_LABEL instead.
+ */
+export const ITEM_NOT_EXISTS: string = ITEM_NOT_EXISTS_ERROR_LABEL  // Deprecated:
+/**
+ * This error is raises if the `index` is out of range.
+ */
+export const INDEX_OUT_OF_RANGE_ERROR_LABEL: string = "[INDEX_OUT_OF_RANGE]"
 
 
 /**
@@ -188,7 +203,7 @@ export class BunSqliteKeyValue {
 
 
     /**
-     * Delete all expired records
+     * Deletes all expired records.
      */
     deleteExpired() {
         this.deleteExpiredStatement.run({now: Date.now()})
@@ -196,7 +211,7 @@ export class BunSqliteKeyValue {
 
 
     /**
-     * Delete one or multiple items
+     * Deletes one or multiple items.
      *
      * Inspired by: https://docs.keydb.dev/docs/commands/#del
      *
@@ -225,7 +240,7 @@ export class BunSqliteKeyValue {
 
 
     /**
-     * Delete all items
+     * Deletes all items
      */
     clear() {
         this.delete()
@@ -712,9 +727,23 @@ export class BunSqliteKeyValue {
     }
 
 
-    // Do not use it with several very large amounts of data or blobs.
-    // This is because the entire data record with all fields is always read and written.
-    // Inspired by: https://docs.keydb.dev/docs/commands/#hset
+    //
+
+    /**
+     * Hash (Map Object) - Write Value
+     *
+     * Do not use it with several very large amounts of data or blobs.
+     * This is because the entire data record with all fields is always read and written.
+     *
+     * Inspired by: https://docs.keydb.dev/docs/commands/#hset
+     *
+     * @category Hash (Map Object)
+     * @param {Key} key
+     * @param {Field} field
+     * @param {T} value
+     * @param {TtlMs} ttlMs
+     * @returns {boolean}
+     */
     hSet(key: Key, field: Field, value: T, ttlMs?: TtlMs): boolean {
         // @ts-ignore (Transaction returns boolean, not void.)
         return this.db.transaction(() => {
@@ -727,9 +756,21 @@ export class BunSqliteKeyValue {
     }
 
 
-    // Do not use it with several very large amounts of data or blobs.
-    // This is because the entire data record with all fields is always read and written.
-    // Inspired by: https://docs.keydb.dev/docs/commands/#hget
+
+
+    /**
+     * Hash (Map Object) - Read Value
+     *
+     * Do not use it with several very large amounts of data or blobs.
+     * This is because the entire data record with all fields is always read and written.
+     *
+     * Inspired by: https://docs.keydb.dev/docs/commands/#hget
+     *
+     * @category Hash (Map Object)
+     * @param {Key} key
+     * @param {Field} field
+     * @returns {T | undefined}
+     */
     hGet(key: Key, field: Field): T | undefined {
         const map = this.get>(key)
         if (map === undefined) return
@@ -737,9 +778,19 @@ export class BunSqliteKeyValue {
     }
 
 
-    // Do not use it with several very large amounts of data or blobs.
-    // This is because the entire data record with all fields is always read and written.
-    // Inspired by: https://docs.keydb.dev/docs/commands/#hmset
+    /**
+     * Hash (Map Object) - Write Multiple Values
+     *
+     * Do not use it with several very large amounts of data or blobs.
+     * This is because the entire data record with all fields is always read and written.
+     *
+     * Inspired by: https://docs.keydb.dev/docs/commands/#hmset
+     *
+     * @category Hash (Map Object)
+     * @param {Key} key
+     * @param {{[p: Field]: T}} fields
+     * @param {TtlMs} ttlMs
+     */
     hmSet(key: Key, fields: {[field: Field]: T}, ttlMs?: TtlMs) {
         this.db.transaction(() => {
             const map = this.get>(key) ?? new Map()
@@ -751,9 +802,19 @@ export class BunSqliteKeyValue {
     }
 
 
-    // Do not use it with several very large amounts of data or blobs.
-    // This is because the entire data record with all fields is always read and written.
-    // Inspired by: https://docs.keydb.dev/docs/commands/#hmget
+    /**
+     * Hash (Map Object) - Read Multiple Values
+     *
+     * Do not use it with several very large amounts of data or blobs.
+     * This is because the entire data record with all fields is always read and written.
+     *
+     * Inspired by: https://docs.keydb.dev/docs/commands/#hmget
+     *
+     * @category Hash (Map Object)
+     * @param {Key} key
+     * @param {string[]} fields
+     * @returns {{[p: Field]: T | undefined} | undefined}
+     */
     hmGet(key: Key, fields?: string[]): {[field: Field]: T | undefined} | undefined {
         const map = this.get>(key)
         if (map === undefined) return
@@ -769,10 +830,21 @@ export class BunSqliteKeyValue {
     }
 
 
-    // Returns if `field` is an existing field in the hash stored at `key`.
-    // Do not use it with several very large amounts of data or blobs.
-    // This is because the entire data record with all fields is always read.
-    // Inspired by: https://docs.keydb.dev/docs/commands/#hexists
+    /**
+     * Hash (Map Object) - Has Field
+     *
+     * Returns if `field` is an existing field in the hash stored at `key`.
+     *
+     * Do not use it with several very large amounts of data or blobs.
+     * This is because the entire data record with all fields is always read.
+     *
+     * Inspired by: https://docs.keydb.dev/docs/commands/#hexists
+     *
+     * @category Hash (Map Object)
+     * @param {Key} key
+     * @param {Field} field
+     * @returns {boolean | undefined}
+     */
     hHasField(key: Key, field: Field): boolean | undefined {
         const map = this.get>(key)
         if (map === undefined) return
@@ -784,7 +856,15 @@ export class BunSqliteKeyValue {
     hExists = this.hHasField
 
 
-    // Inspired by: https://docs.keydb.dev/docs/commands/#hlen
+    /**
+     * Hash (Map Object) - Count Fields
+     *
+     * Inspired by: https://docs.keydb.dev/docs/commands/#hlen
+     *
+     * @category Hash (Map Object)
+     * @param {Key} key
+     * @returns {number | undefined}
+     */
     hGetCount(key: Key): number | undefined {
         const map = this.get>(key)
         if (map === undefined) return
@@ -796,7 +876,15 @@ export class BunSqliteKeyValue {
     hLen = this.hGetCount
 
 
-    // Inspired by: https://docs.keydb.dev/docs/commands/#hkeys
+    /**
+     * Hash (Map Object) - Get All Field Names
+     *
+     * Inspired by: https://docs.keydb.dev/docs/commands/#hkeys
+     *
+     * @category Hash (Map Object)
+     * @param {Key} key
+     * @returns {string[] | undefined}
+     */
     hGetFields(key: Key): string[] | undefined {
         const map = this.get>(key)
         if (map === undefined) return
@@ -804,9 +892,7 @@ export class BunSqliteKeyValue {
     }
 
 
-    /**
-     * Alias for hGetFields()
-     */
+    // Alias for hGetFields()
     hKeys = this.hGetFields
 
 
@@ -821,6 +907,7 @@ export class BunSqliteKeyValue {
      *
      * Inspired by: https://docs.keydb.dev/docs/commands/#hvals
      *
+     * @category Hash (Map Object)
      * @param {Key} key
      * @returns {T[] | undefined}
      *  If the data record (marked with `key`) does not exist, `undefined` is returned.
@@ -845,17 +932,16 @@ export class BunSqliteKeyValue {
     }
 
 
-    /**
-     * Alias for hGetValues()
-     */
+    // Alias for hGetValues()
     hVals = this.hGetValues
 
 
     /**
-     * Hash function: Delete a field of the map object.
+     * Hash function: Deletes a field of the map object.
      *
      * Inspired by: https://docs.keydb.dev/docs/commands/#hdel
      *
+     * @category Hash (Map Object)
      * @param {Key} key - The key of the item.
      * @param {Field} field - The name of the field.
      * @returns {boolean | undefined}
@@ -878,6 +964,7 @@ export class BunSqliteKeyValue {
     /**
      * Inspired by: https://docs.keydb.dev/docs/commands/#hincrby
      *
+     * @category Hash (Map Object)
      * @param {Key} key
      * @param {Field} field
      * @param {number} incrBy
@@ -906,6 +993,7 @@ export class BunSqliteKeyValue {
     /**
      * Inspired by: https://docs.keydb.dev/docs/commands/#hincrby
      *
+     * @category Hash (Map Object)
      * @param {Key} key
      * @param {Field} field
      * @param {number} decrBy
@@ -922,6 +1010,7 @@ export class BunSqliteKeyValue {
      *
      * Inspired by: https://docs.keydb.dev/docs/commands/#lpush
      *
+     * @category List (Array Object)
      * @param {Key} key
      * @param {T} values
      * @returns {number}
@@ -953,6 +1042,7 @@ export class BunSqliteKeyValue {
      *
      * Inspired by: https://docs.keydb.dev/docs/commands/#rpush
      *
+     * @category List (Array Object)
      * @param {Key} key
      * @param {T} values
      * @returns {number}
@@ -983,6 +1073,7 @@ export class BunSqliteKeyValue {
      *
      * Inspired by: https://docs.keydb.dev/docs/commands/#lpop
      *
+     * @category List (Array Object)
      * @param {Key} key
      * @param {number} count
      * @returns { T | T[] | undefined}
@@ -1023,6 +1114,7 @@ export class BunSqliteKeyValue {
      *
      * Inspired by: https://docs.keydb.dev/docs/commands/#rpop
      *
+     * @category List (Array Object)
      * @param {Key} key
      * @param {number} count
      * @returns {T[] | T | undefined}
@@ -1067,6 +1159,7 @@ export class BunSqliteKeyValue {
      *
      * Inspired by: https://docs.keydb.dev/docs/commands/#lindex
      *
+     * @category List (Array Object)
      * @param {Key} key
      * @param {number} index
      * @returns {T | undefined}
@@ -1094,6 +1187,7 @@ export class BunSqliteKeyValue {
      *
      * Inspired by: https://www.dragonflydb.io/docs/command-reference/lists/llen
      *
+     * @category List (Array Object)
      * @param {Key} key
      * @returns {number}
      *  The length of the list at `key`.
@@ -1108,20 +1202,46 @@ export class BunSqliteKeyValue {
     }
 
 
-    // ToDo: lSet()
-    // Achtung, wenn ein Index übergeben wird, der nicht im Array enthalten ist, soll ein Fehler ausgelöst werden.
-    // Achtung, es können auch negative Werte wie bei `.at()` als Index verwendet werden.
-    //
-    // function setAt(array: Array, index: number, value: T) {
-    //     const len = array.length
-    //     if (index < 0) {
-    //         array[len + index] = value
-    //     } else {
-    //         array[index] = value
-    //     }
-    // }
-    //
-    // Inspired by: https://docs.keydb.dev/docs/commands/#lset
+    /**
+     * Updates the list element at `index` to `value`.
+     *
+     * For more information on the index argument, see `lIndex()`.
+     *
+     * An error is returned if the key does not exist.
+     * An error is returned when the value stored at `key` is not an array.
+     * An error is returned for out of range indexes.
+     *
+     * Inspired by: https://www.dragonflydb.io/docs/command-reference/lists/lset
+     *
+     * @category List (Array Object)
+     * @param {Key} key
+     * @param {number} index
+     * @param {T} value
+     * @returns `true` if the `key` exists and the value has been set.
+     */
+    lSet(key: Key, index: number, value: T): true {
+        // @ts-ignore (Transaction returns boolean or undefined, not void.)
+        return this.db.transaction(() => {
+            const array = this.get>(key)
+            if (array === undefined) {
+                throw new Error(ITEM_NOT_EXISTS_ERROR_LABEL + ` Key "${key.substring(-80)}" not found.`)
+            }
+            if (Array.isArray(array) === false) {
+                throw new Error(NO_ARRAY_ERROR_LABEL + ` Value at "${key.substring(-80)}" is not an array.`)
+            }
+            const len = array.length
+            if (index >= len || index < (len * -1)) {
+                throw new Error(INDEX_OUT_OF_RANGE_ERROR_LABEL + ` Array length: ${len}`)
+            }
+            if (index < 0) {
+                array[len + index] = value
+            } else {
+                array[index] = value
+            }
+            this.set>(key, array)
+            return true
+        }).immediate()
+    }
 
 
     // ToDo: lRange()
@@ -1197,6 +1317,7 @@ export class BunSqliteKeyValue {
      *
      * Raises an error if the item key does not exist.
      *
+     * @category Tags (Labels)
      * @param {Key} key
      * @param {Tag} tag
      * @returns {boolean}
@@ -1208,7 +1329,7 @@ export class BunSqliteKeyValue {
             return this.addTagStatement.run({item_key: key, tag}).changes === 1
         } catch (error: any) {
             if (error.toString().includes("FOREIGN KEY constraint failed")) {
-                throw new Error(ITEM_NOT_EXISTS)
+                throw new Error(ITEM_NOT_EXISTS_ERROR_LABEL + ` Key "${key.substring(-80)}" not found.`)
             } else {
                 throw error
             }
@@ -1219,6 +1340,7 @@ export class BunSqliteKeyValue {
     /**
      * Deletes a tag of an item.
      *
+     * @category Tags (Labels)
      * @param {Key} key
      * @param {Tag} tag
      * @returns {boolean}
@@ -1233,6 +1355,7 @@ export class BunSqliteKeyValue {
     /**
      * Deletes multiple tags or all tags of the item.
      *
+     * @category Tags (Labels)
      * @param {Key} key
      * @param {Tag[] | undefined} tags
      *  Deletes all tags within the array.
@@ -1252,6 +1375,7 @@ export class BunSqliteKeyValue {
     /**
      * Deletes tagged items.
      *
+     * @category Tags (Labels)
      * @param {Tag} tag
      */
     deleteTaggedItems(tag: Tag) {
@@ -1259,6 +1383,13 @@ export class BunSqliteKeyValue {
     }
 
 
+    /**
+     * Returns tagged keys.
+     *
+     * @category Tags (Labels)
+     * @param {Tag} tag
+     * @returns {Key[] | undefined}
+     */
     getTaggedKeys(tag: Tag): Key[] | undefined {
         const records = this.getTaggedKeysStatement.all({tag})
         if (!records?.length) return
@@ -1266,6 +1397,13 @@ export class BunSqliteKeyValue {
     }
 
 
+    /**
+     * Returns tagged values.
+     *
+     * @category Tags (Labels)
+     * @param {Tag} tag
+     * @returns {(T | undefined)[] | undefined}
+     */
     getTaggedValues(tag: Tag): (T | undefined)[] | undefined {
         return this.db.transaction(() => {
             const taggedKeys = this.getTaggedKeys(tag)
@@ -1275,6 +1413,13 @@ export class BunSqliteKeyValue {
     }
 
 
+    /**
+     * Returns tagged items.
+     *
+     * @category Tags (Labels)
+     * @param {Tag} tag
+     * @returns {Item[] | undefined}
+     */
     getTaggedItems(tag: Tag): Item[] | undefined {
         return this.db.transaction(() => {
             const taggedKeys = this.getTaggedKeys(tag)
diff --git a/tests/memory.test.ts b/tests/memory.test.ts
index c21aa8f..ebbafed 100644
--- a/tests/memory.test.ts
+++ b/tests/memory.test.ts
@@ -1,9 +1,8 @@
 import { expect, test } from "bun:test"
-import { BunSqliteKeyValue, INVALID_COUNT_ERROR_LABEL, ITEM_NOT_EXISTS, NO_ARRAY_ERROR_LABEL } from "../src"
+import { BunSqliteKeyValue, INDEX_OUT_OF_RANGE_ERROR_LABEL, INVALID_COUNT_ERROR_LABEL, ITEM_NOT_EXISTS_ERROR_LABEL, NO_ARRAY_ERROR_LABEL } from "../src"
 import { Statement } from "bun:sqlite"
 import type { Item } from "../src/interfaces.ts"
 
-
 const KEY_1: string = "test-key-1"
 const KEY_2: string = "test-key-2"
 const KEY_3: string = "test-key-3"
@@ -893,7 +892,7 @@ test("Add tags", async () => {
     // Item does not exist.
     expect(() => {
         store.addTag(KEY_2, TAG_1)
-    }).toThrowError(ITEM_NOT_EXISTS)
+    }).toThrowError(ITEM_NOT_EXISTS_ERROR_LABEL)
 })
 
 
@@ -1016,3 +1015,24 @@ test("lLen()", async () => {
     }).toThrowError(NO_ARRAY_ERROR_LABEL)
     expect(store.lLen(KEY_3)).toEqual(0)
 })
+
+
+test("lSet()", async () => {
+    const store = new BunSqliteKeyValue()
+
+    store.rPush(KEY_1, "one", "two", "three")
+
+    expect(store.lSet(KEY_1, 0, "four")).toBeTrue()
+    expect(store.lSet(KEY_1, -2, "five")).toBeTrue()
+    expect(store.get>(KEY_1)).toEqual(["four", "five", "three"])
+    expect(() => {
+        store.lSet(KEY_1, 3, "six")
+    }).toThrowError(INDEX_OUT_OF_RANGE_ERROR_LABEL)
+    expect(() => {
+        store.lSet(KEY_1, -4, "seven")
+    }).toThrowError(INDEX_OUT_OF_RANGE_ERROR_LABEL)
+    expect(() => {
+        store.lSet(KEY_2, 0, "eight")
+    }).toThrowError(ITEM_NOT_EXISTS_ERROR_LABEL)
+
+})
diff --git a/typedoc.json b/typedoc.json
index 7b38486..e03e64b 100644
--- a/typedoc.json
+++ b/typedoc.json
@@ -1,21 +1,25 @@
 {
   "$schema": "https://typedoc.org/schema.json",
   "entryPoints": [
-    "src/index.ts"
+    "src/*.ts",
+    "src/**/*.ts"
   ],
-  "out": "docs/api",
+  "out": "docs",
   "name": "Bun SQlite Key Value",
   "navigationLinks": {
     "GitHub": "https://github.com/gerold-penz/bun-sqlite-key-value"
   },
-  "exclude": [
-    "./README.md"
-  ],
   "lightHighlightTheme": "github-light",
   "darkHighlightTheme": "github-dark",
   "sourceLinkExternal": true,
   "searchInComments": true,
   "searchInDocuments": true,
-  "excludeNotDocumented": true
+  "excludeNotDocumented": true,
+  "customFooterHtml": "By Gerold Penz - GP-Softwaretechnik.",
+  "hideParameterTypesInTitle": false
+  //  "exclude": [
+  //    "./README.md"
+  //  ],
+  //  "projectDocuments": ["./README.md"],
   //  "readme": "none"
 }