Giter Club home page Giter Club logo

bytedecoder.common's Introduction

ByteDecoder.Common

.NET Core Maintainability Test Coverage CodeQL License

Common utility classes, guard clauses, and more.

Targeted to .Net6 onwards

Installation

Install the ByteDecoder.Common NuGet Package.

Package Manager Console

Install-Package ByteDecoder.Common

.NET Core CLI

dotnet add package ByteDecoder.Common

Documentation

All the documentation can be found on the github page.

Examples and usage

Guard Clauses

They are a piece of code in charge of protecting params at the top of methods against undesirable values.

Supported Guard Clauses:

  • IfArgumentIsNull
  • IfArgumentIsNullOrEmpty
  • IfArgumentOutOfRange

Usage examples:

using ByteDecoder.Common.GuardClauses;

// Null Argument Guard check
public void MethodOne(IEnumerable<string> collection)
{
  Guard.Break.IfArgumentIsNull(collection, nameof(collection));

  // More logic code if the param is suitable after the guard evaluates the condition.
}

// String is NUll or Empty Guard check
public void MethodTwo(string word)
{
  Guard.Break.IfArgumentIsNull(word, nameof(word));

  // More logic code if the param is suitable after the guard evaluates the condition.
}

// Calling the method and passing a null value in the param
MethodOne((IEnumerable<string>) null);  // This will throw an ArgumentNullException
MethodTwo(string.Empty);  // This will throw an ArgumentNullException

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ByteDecoder/ByteDecoder.Common.

Copyright (c) 2020 Rodrigo Reyes released under the MIT license

bytedecoder.common's People

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.