{"id":18809910,"url":"https://github.com/bytebit-org/roblox-must","last_synced_at":"2026-05-09T19:44:31.361Z","repository":{"id":57683520,"uuid":"472485295","full_name":"Bytebit-Org/roblox-Must","owner":"Bytebit-Org","description":"A simple function that just errors out if the value it is given is nil / undefined.","archived":false,"fork":false,"pushed_at":"2022-04-05T05:19:07.000Z","size":192,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-06-27T11:41:06.231Z","etag":null,"topics":["game-development","lua","luau","npm-package","roblox","roblox-ts"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Bytebit-Org.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-03-21T19:36:10.000Z","updated_at":"2022-03-21T20:51:36.000Z","dependencies_parsed_at":"2022-09-05T17:31:22.285Z","dependency_job_id":null,"html_url":"https://github.com/Bytebit-Org/roblox-Must","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bytebit-Org%2Froblox-Must","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bytebit-Org%2Froblox-Must/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bytebit-Org%2Froblox-Must/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bytebit-Org%2Froblox-Must/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Bytebit-Org","download_url":"https://codeload.github.com/Bytebit-Org/roblox-Must/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239743908,"owners_count":19689563,"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":["game-development","lua","luau","npm-package","roblox","roblox-ts"],"created_at":"2024-11-07T23:18:09.332Z","updated_at":"2026-01-10T13:30:14.620Z","avatar_url":"https://github.com/Bytebit-Org.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Must\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/Bytebit-Org/roblox-Must/actions\"\u003e\n      \u003cimg src=\"https://github.com/Bytebit-Org/roblox-Must/workflows/CI/badge.svg\" alt=\"CI status\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"http://makeapullrequest.com\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/PRs-welcome-blue.svg\" alt=\"PRs Welcome\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://opensource.org/licenses/MIT\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/License-MIT-blue.svg\" alt=\"License: MIT\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://discord.gg/QEz3v8y\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/discord-join-7289DA.svg?logo=discord\u0026longCache=true\u0026style=flat\" alt=\"Discord server\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\nMust is just a simple function that errors out if the argument is nil / undefined.\n\n## Installation\n### roblox-ts\nSimply install to your [roblox-ts](https://roblox-ts.com/) project as follows:\n```\nnpm i @rbxts/must\n```\n\n### Wally\n[Wally](https://github.com/UpliftGames/wally/) users can install this package by adding the following line to their `Wally.toml` under `[dependencies]`:\n```\nMust = \"bytebit/must@1.0.5\"\n```\n\nThen just run `wally install`.\n\n### From model file\nModel files are uploaded to every release as `.rbxmx` files. You can download the file from the [Releases page](https://github.com/Bytebit-Org/roblox-Must/releases) and load it into your project however you see fit.\n\n### From model asset\nNew versions of the asset are uploaded with every release. The asset can be added to your Roblox Inventory and then inserted into your Place via Toolbox by getting it [here.](https://www.roblox.com/library/9164403107/Warn-Function)\n\n## Documentation\nDocumentation can be found [here](https://github.com/Bytebit-Org/roblox-Must/tree/master/docs), is included in the TypeScript files directly, and was generated using [TypeDoc](https://typedoc.org/).\n\n## Example\nHere's a simple example of a function that just wants to throw if the value it looks up is `nil` / `undefined`.\n\n\u003cdetails\u003e\n  \u003csummary\u003eroblox-ts example\u003c/summary\u003e\n\n  ```ts\n  import { must } from \"@rbxts/must\";\n\n  export class Foo {\n    public bar() {\n      const fetchedValue = must(fetchSomeValue());\n      \n      // more logic\n    }\n  }\n  ```\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eLuau example\u003c/summary\u003e\n\n  ```lua\n  local must = require(path.to.modules[\"must\"]).must\n\n  local Foo = {}\n  Foo.__index = Foo\n\n  function new()\n    local self = {}\n    setmetatable(self, Foo)\n\n    return self\n  end\n\n  function Foo:bar()\n    local fetchedValue = must(fetchSomeValue())\n\n    -- more logic\n  end\n\n  return {\n    new = new\n  }\n  ```\n\u003c/details\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbytebit-org%2Froblox-must","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbytebit-org%2Froblox-must","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbytebit-org%2Froblox-must/lists"}