https://github.com/lecaillon/preconditions

Preconditions.NET provides convenience static methods to help check that a method or a constructor is invoked with proper parameter or not.
https://github.com/lecaillon/preconditions

argument-checks check guard preconditions

Last synced: about 2 months ago
JSON representation

Preconditions.NET provides convenience static methods to help check that a method or a constructor is invoked with proper parameter or not.

• Host: GitHub
• URL: https://github.com/lecaillon/preconditions
• Owner: lecaillon
• License: mit
• Created: 2016-11-24T20:35:21.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2022-02-16T15:27:21.000Z (almost 3 years ago)
• Last Synced: 2024-10-12T02:47:01.827Z (2 months ago)
• Topics: argument-checks, check, guard, preconditions
• Language: C#
• Homepage:
• Size: 67.4 KB
• Stars: 25
• Watchers: 5
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Preconditions.NET [![AppVeyor build status](https://ci.appveyor.com/api/projects/status/p1qsj8wt27023w0u/branch/master?svg=true)](https://ci.appveyor.com/project/lecaillon/preconditions/branch/master) [![NuGet](https://buildstats.info/nuget/Preconditions.NET)](https://www.nuget.org/packages/Preconditions.NET)



Preconditions.NET is a personal, free-time project with no funding. If you use Evolve in your daily work and feel that it makes your life easier, consider supporting its development via [GitHub Sponsors](https://github.com/sponsors/lecaillon) :heart: and by adding a star to this repository :star:

## Introduction

Preconditions.NET provides convenience static methods to help check that a method or a constructor is invoked with proper parameter or not. In other words it checks the *pre-conditions*. The goal of this class is to improve readability of code.

Preconditions.NET returns the tested value on success, allowing to check and call a method at the same time.

On failure it **always** throws an `ArgumentException`, `ArgumentNullException` or `ArgumentOutOfRangeException`.

## Why Preconditions.NET v2 ?

Preconditions.NET v2.0.0 is a complete rewrite that takes advantage of nullable types, the `NotNull` attribute and the new .NET 6 `CallerArgumentExpression` attribute.

It is no more mandatory to pass the parameter name being checked.

It also adds new methods (cf. [checklist](#the-checklist)) and remove Check.Zero().

## How to use it ?

Because Preconditions.NET is only one code file, you can either copy the [Check.cs](https://github.com/lecaillon/Preconditions/blob/master/src/Preconditions/Check.cs) class or include the NuGet package to your project :

```

PM> Install-Package Preconditions.NET

```

## Example

```c#

public class Employee : Person

{

    public Employee(string name, string id) : base(Check.NotNullOrEmpty(name))

    {

        Id = Check.NullableButNotEmpty(id);

    }

    public string Id { get; }

}

```

## The checklist

- Check.NotNull(*object*)

- Check.NullableButNotEmpty (*string*)

- Check.NotNullOrEmpty(*string*)

- Check.NotNullOrEmpty(*IEnumerable*)

- Check.HasNoNulls(*IEnumerable*)

- Check.NotEmpty(*Guid*)

- Check.FileExists()

- Check.DirectoryExists()

- Check.Positive()

- Check.PositiveOrNull()

- Check.Negative()

- Check.NegativeOrNull()

- Check.NotNegative()

- Check.NotNegativeOrNull()

- Check.True(*Func*)

## Feedback and issues

Feedback, improvements, ideas are welcomed.

Feel free to create new [issues](https://github.com/lecaillon/Preconditions/issues) at the issues section.