{"id":26708503,"url":"https://github.com/triformine/kwik","last_synced_at":"2025-04-13T16:22:35.024Z","repository":{"id":40793151,"uuid":"390878729","full_name":"TriForMine/kwik","owner":"TriForMine","description":"Kwik is a deno database using messagepack files.","archived":false,"fork":false,"pushed_at":"2023-10-19T11:45:37.000Z","size":63,"stargazers_count":4,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-27T07:18:34.968Z","etag":null,"topics":["database","deno","deno-module","hacktoberfest","messagepack","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TriForMine.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-07-29T23:58:07.000Z","updated_at":"2022-09-13T09:30:56.000Z","dependencies_parsed_at":"2024-11-17T14:11:34.918Z","dependency_job_id":"87673986-84f7-4b7b-93d7-bdcf50d6f1a7","html_url":"https://github.com/TriForMine/kwik","commit_stats":{"total_commits":62,"total_committers":2,"mean_commits":31.0,"dds":"0.032258064516129004","last_synced_commit":"d5991eb43ed8a62f22e78c52ae421e0888e096eb"},"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TriForMine%2Fkwik","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TriForMine%2Fkwik/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TriForMine%2Fkwik/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TriForMine%2Fkwik/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TriForMine","download_url":"https://codeload.github.com/TriForMine/kwik/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248741851,"owners_count":21154389,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["database","deno","deno-module","hacktoberfest","messagepack","typescript"],"created_at":"2025-03-27T07:18:45.357Z","updated_at":"2025-04-13T16:22:35.004Z","avatar_url":"https://github.com/TriForMine.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Kwik\n\n[![nest badge](https://nest.land/badge.svg)](https://nest.land/package/Kwik)\n\nKwik is a deno database using messagepack files.\n\nBased on: [sabr](https://deno.land/x/sabr)\n\n# Warning\n\nThis project was done mainly to experiment with\n[messagepack](http://msgpack.org/index.html) and files. This would never be as\ngood as sql/nosql databases. It isn't recommended using that module for\nproduction projects. Except if you know what you are doing, file database are\nslower and might have issues.\n\n# Examples\n\n```ts\nimport { Kwik, KwikTable } from \"https://deno.land/x/kwik@v1.3.1/mod.ts\";\n\ninterface UserSchema {\n  username: string;\n  createdAt: Date;\n}\n\nconst kwik = new Kwik();\nconst users = new KwikTable\u003cUserSchema\u003e(kwik, \"users\");\n\nawait kwik.init();\n\nconst userId = kwik.uuid4();\nawait users.set(userId, {\n  username: \"TriForMine\",\n  createdAt: new Date(),\n});\nif (await users.has(userId)) {\n  const user = await users.get(userId);\n  console.log(user);\n} else {\n  console.error(\"An error occurred, the user was not added to the database.\");\n}\n```\n\n# Message Pack Customization\n\nHere is an example to set up custom extension types for\n[msgpack](https://deno.land/x/msgpack_javascript@v2.7.1#extension-types)\n\n```ts\nimport {\n  decode,\n  encode,\n  Kwik,\n  KwikTable,\n} from \"https://deno.land/x/kwik@v1.3.1/mod.ts\";\n\nconst kwik = new Kwik();\nconst table = new KwikTable(kwik, \"table\");\n\n// Add Map\u003cT\u003e supports\nkwik.msgpackExtensionCodec.register({\n  type: 1,\n  encode: (object: unknown): Uint8Array | null =\u003e {\n    if (object instanceof Map) {\n      return encode([...object], {});\n    } else {\n      return new Uint8Array(0);\n    }\n  },\n  decode: (data: Uint8Array) =\u003e {\n    const array = decode(data, {}) as Array\u003c[unknown, unknown]\u003e;\n    return new Map(array);\n  },\n});\n\nawait kwik.init();\n\nawait table.set(\"test\", new Map\u003cstring, string\u003e());\n```\n\n# Handling BigInt\n\n```ts\nimport {\n  decode,\n  encode,\n  Kwik,\n  KwikTable,\n} from \"https://deno.land/x/kwik@v1.3.1/mod.ts\";\n\nconst kwik = new Kwik();\nconst table = new KwikTable(kwik, \"table\");\n\n// Add BigInt supports\nkwik.msgpackExtensionCodec.register({\n  type: 0,\n  encode: (object: unknown): Uint8Array | null =\u003e {\n    if (typeof object === \"bigint\") {\n      if (\n        object \u003c= Number.MAX_SAFE_INTEGER \u0026\u0026 object \u003e= Number.MIN_SAFE_INTEGER\n      ) {\n        return encode(parseInt(object.toString(), 10), {});\n      } else {\n        return encode(object.toString(), {});\n      }\n    } else {\n      return null;\n    }\n  },\n  decode: (data: Uint8Array) =\u003e {\n    return BigInt(decode(data, {}) as string);\n  },\n});\n\nawait kwik.init();\n\nawait table.set(\"test\", 5n);\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftriformine%2Fkwik","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftriformine%2Fkwik","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftriformine%2Fkwik/lists"}