{"id":31919877,"url":"https://github.com/heleonix/heleonix.guard","last_synced_at":"2025-10-13T21:48:19.346Z","repository":{"id":65505917,"uuid":"138220190","full_name":"Heleonix/Heleonix.Guard","owner":"Heleonix","description":"Provides performant guard functionality for methods to throw exceptions","archived":false,"fork":false,"pushed_at":"2024-03-30T23:14:58.000Z","size":30,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-03-31T00:21:20.628Z","etag":null,"topics":["codecontract","guard","heleonix","throw"],"latest_commit_sha":null,"homepage":"","language":"C#","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/Heleonix.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}},"created_at":"2018-06-21T20:48:27.000Z","updated_at":"2024-03-31T00:21:20.628Z","dependencies_parsed_at":"2023-01-26T13:45:16.187Z","dependency_job_id":null,"html_url":"https://github.com/Heleonix/Heleonix.Guard","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/Heleonix/Heleonix.Guard","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Heleonix%2FHeleonix.Guard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Heleonix%2FHeleonix.Guard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Heleonix%2FHeleonix.Guard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Heleonix%2FHeleonix.Guard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Heleonix","download_url":"https://codeload.github.com/Heleonix/Heleonix.Guard/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Heleonix%2FHeleonix.Guard/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279017020,"owners_count":26085951,"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","status":"online","status_checked_at":"2025-10-13T02:00:06.723Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["codecontract","guard","heleonix","throw"],"created_at":"2025-10-13T21:47:27.521Z","updated_at":"2025-10-13T21:48:19.338Z","avatar_url":"https://github.com/Heleonix.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Heleonix.Guard\n\n[![Release: .NET / NuGet](https://github.com/Heleonix/Heleonix.Guard/actions/workflows/release-net-nuget.yml/badge.svg)](https://github.com/Heleonix/Heleonix.Guard/actions/workflows/release-net-nuget.yml)\n\nProvides performant guard functionality for methods to throw exceptions\n\n## Install\n\nhttps://www.nuget.org/packages/Heleonix.Guard\n\n## Documentation\n\nSee [Heleonix.Guard](https://heleonix.github.io/docs/Heleonix.Guard)\n\n## Example\n\n```csharp\nusing Heleonix.Guard;\nusing Heleonix.Extensions;\nusing static Heleonix.Guard.Host;\n\npublic static class Test\n{\n    public static void Main()\n    {\n        MyMethod(null);\n    }\n\n    public static void MyMethod(string param)\n    {\n        // C# 7.2+: Non-Trailing named arguments\n        Throw.ArgumentNullException(when: param.IsNull(), nameof(param));\n\n        // OR\n\n        // Prior to C# 7.2: You can use a helper method 'When'\n        Throw.ArgumentNullException(When(param.IsNull()), nameof(param));\n\n        // OR\n        Throw.ArgumentNullException(param == null, nameof(param));\n\n        // OR\n        Throw.ArgumentNullException(When(param == null), nameof(param));\n    }\n}\n```\n\nThe `Heleonix.Extensions` provides many useful predicative extensions to build assertions,\nlike `IsNull()`, `IsNullOrEmptyOrWhiteSpace()`, `IsLessThan()` etc.\n**These extensions do not throw exceptions**, so they will not overlap an exception to be really thrown. See [Heleonix.Extensions](https://github.com/Heleonix/Heleonix.Extensions) for more details.\n\nThe `Host.Throw` property returns a singleton instance of the `Heleonix.Guard.ExceptionRaiser` class,\nwhich provides methods to throw many existing exceptions, like `ArgumentNullException`, `FileLoadException` etc.\nSee more via VisualStudio intellisense.\n\nThe `ExceptionRaiser` returned by the `Host.Throw` is the singleton instance, so there is no creations of new objects every time,\nas it is usually implemented in fluent interfaces. Besides, it also provides ability to implement custom exception raisers via extension methods:\n\n```csharp\nusing Heleonix.Guard;\n\npublic static class ExceptionRaiserExtensions\n{\n#pragma warning disable CC0057 // Unused parameters\n    public static void MyCustomException(this ExceptionRaiser raiser, bool when, int param1, string param2, object paramN, string message = null, Exception innerException = null)\n    {\n        if (when)\n        {\n            throw new MyCustomException(param1, param2, paramN, message, innerException);\n        }\n    }\n#pragma warning restore CC0057 // Unused parameters\n}\n```\n\nand then use it, for example, as below:\n\n```csharp\nThrow.MyCustomException(when: param1.IsZero() || param2.IsNullOrEmpty() || paramN.IsNull(), \"some message\");\n```\n\n## Contribution Guideline\n\n1. [Create a fork](https://github.com/Heleonix/Heleonix.Guard/fork) from the main repository\n2. Implement whatever is needed\n3. [Create a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).\n   Make sure the assigned [Checks](https://github.com/Heleonix/Heleonix.Guard/actions/workflows/pr-net.yml) pass successfully.\n4. [Request review](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review) from the code owner\n5. Once approved, merge your Pull Request via [Squash and merge](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#squash-and-merge-your-commits)\n\n   \u003e **IMPORTANT**  \n   \u003e While merging, enter a [Conventional Commits](https://www.conventionalcommits.org/) commit message.\n   \u003e This commit message will be used in automatically generated [Github Release Notes](https://github.com/Heleonix/Heleonix.Guard/releases)\n   \u003e and [NuGet Release Notes](https://www.nuget.org/packages/Heleonix.Guard/#releasenotes-body-tab)\n\n5. Monitor the [Release: .NET / NuGet](https://github.com/Heleonix/Heleonix.Guard/actions/workflows/release-net-nuget.yml)\n   GitHub workflow to make sure your changes are delivered successfully\n5. In case of any issues, please contact [heleonix.sln@gmail.com](mailto:heleonix.sln@gmail.com)\n5. ","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fheleonix%2Fheleonix.guard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fheleonix%2Fheleonix.guard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fheleonix%2Fheleonix.guard/lists"}