magic.lambda.validators 13.4.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package magic.lambda.validators --version 13.4.0                
NuGet\Install-Package magic.lambda.validators -Version 13.4.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="magic.lambda.validators" Version="13.4.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add magic.lambda.validators --version 13.4.0                
#r "nuget: magic.lambda.validators, 13.4.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install magic.lambda.validators as a Cake Addin
#addin nuget:?package=magic.lambda.validators&version=13.4.0

// Install magic.lambda.validators as a Cake Tool
#tool nuget:?package=magic.lambda.validators&version=13.4.0                

Validating input arguments from Hyperlambda

This project contains input validators for Magic. More specifically it contains the following slots.

  • [validators.date] - Verifies that some date input is a date, and optionally between [min] and [max] value
  • [validators.email] - Verifies that some input is a legal email address
  • [validators.enum] - Verifies that some input is one of a set of predefined legal values, found as values of children
  • [validators.integer] - Verifies that some integer input (long, int, etc) is between some specified [min] and [max] range
  • [validators.mandatory] - Verifies that some input valus is given (at all)
  • [validators.regex] - Verifies that some input is matching some given [regex] pattern
  • [validators.string] - Verifies that some string input is between [min] and [max] in length
  • [validators.url] - Verifies that some string input is a legal URL, either HTTP or HTTPS type of scheme
  • [validators.recaptcha] - reCAPTCHA validator, to avoid bots from invoking your APIs

All of the above slots takes an expression, or values, as its main input, and will throw exceptions if their input expression's value(s), or its value, does not follow the rules specified by the validator. This makes them perfect fits for "intercepting" the input specified to an HTTP REST endpoint, to verify the input data conforms to some sort of predefined validation scheme.

Usage

.foo
   number:int:11

validators.integer:x:@.foo/*/number
   min:int:5
   max:int:10

Most validators requires some sort of argument(s), such as you can see above in the integer validator - However, some of these validators are without arguments, such as the email validator, that simply verifies the input is a valid email address. To use the [validators.regex] validator, you should probably learn regular expression. However, this is beyond the scope of this article.

Notice - No attempt to invoke the type validator logic will be done unless the value is a non null value. If you want to enforce such logic, you'll have to combine the specific type validators with the [validators.mandatory] validator, which enforces that a value must be specified and be non null.

Internals

You can use one invocation to any of the validators to validate multiple nodes, such as the following illustrates.

.arguments
   .
      no:5
   .
      no:10
   .
      // Throws if you remove the "."
      .no:11

validators.integer:x:@.arguments/*/*/no
   min:5
   max:10

First the above expression will be evaluated, then every resulting value will be validated, and if any of them are not validated according to the validtor's arguments - Which for the above example is number between 5 and 10 - The validater will throw an exception, providing the invalid value, and the name of the last iterator (effectively being the argument name) to the caller. This allows you to use one single validator to validate multiple arguments, such as the above illustrates. This might be useful if you for instance have an endpoint accepting multiple address fields, and zip code is a mandatory argument, and it needs to be an integer with a [max] and [min] value.

Project website

The source code for this repository can be found at github.com/polterguy/magic.lambda.validators, and you can provide feedback, provide bug reports, etc at the same place.

Quality gates

  • Build status
  • Quality Gate Status
  • Bugs
  • Code Smells
  • Coverage
  • Duplicated Lines (%)
  • Lines of Code
  • Maintainability Rating
  • Reliability Rating
  • Security Rating
  • Technical Debt
  • Vulnerabilities
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on magic.lambda.validators:

Package Downloads
magic.library

Helper project for Magic to wire up everything easily by simply adding one package, and invoking two simple methods. When using Magic, this is (probably) the only package you should actually add, since this package pulls in everything else you'll need automatically, and wires up everything sanely by default. To use package go to https://polterguy.github.io

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
17.2.0 429 1/22/2024
17.1.7 185 1/12/2024
17.1.6 166 1/11/2024
17.1.5 177 1/5/2024
17.0.1 231 1/1/2024
17.0.0 376 12/14/2023
16.11.5 340 11/12/2023
16.9.0 328 10/9/2023
16.7.0 571 7/11/2023
16.4.1 412 7/2/2023
16.4.0 412 6/22/2023
16.3.1 341 6/7/2023
16.3.0 357 5/28/2023
16.1.9 635 4/30/2023
15.10.11 505 4/13/2023
15.9.1 645 3/27/2023
15.9.0 513 3/24/2023
15.8.2 542 3/20/2023
15.7.0 417 3/6/2023
15.5.0 1,595 1/28/2023
15.2.0 696 1/18/2023
15.1.0 1,157 12/28/2022
14.5.7 733 12/13/2022
14.5.5 794 12/6/2022
14.5.1 672 11/23/2022
14.5.0 606 11/18/2022
14.4.5 719 10/22/2022
14.4.1 790 10/22/2022
14.4.0 678 10/17/2022
14.3.1 1,274 9/12/2022
14.3.0 631 9/10/2022
14.1.3 932 8/7/2022
14.1.2 657 8/7/2022
14.1.1 673 8/7/2022
14.0.14 702 7/26/2022
14.0.12 679 7/24/2022
14.0.11 642 7/23/2022
14.0.10 674 7/23/2022
14.0.9 663 7/23/2022
14.0.8 754 7/17/2022
14.0.5 793 7/11/2022
14.0.4 776 7/6/2022
14.0.3 735 7/2/2022
14.0.2 687 7/2/2022
14.0.0 851 6/25/2022
13.4.0 2,071 5/31/2022
13.3.4 1,456 5/9/2022
13.3.0 961 5/1/2022
13.2.0 1,166 4/21/2022
13.1.1 745 4/20/2022
13.1.0 820 4/7/2022
13.0.0 756 4/5/2022
11.0.5 1,426 3/2/2022
11.0.4 786 2/22/2022
11.0.3 758 2/9/2022
11.0.2 834 2/6/2022
11.0.1 784 2/5/2022
10.0.21 762 1/28/2022
10.0.20 780 1/27/2022
10.0.19 767 1/23/2022
10.0.18 736 1/17/2022
10.0.15 939 12/31/2021
10.0.14 578 12/28/2021
10.0.7 1,464 12/22/2021
10.0.5 761 12/18/2021
9.9.9 1,681 11/29/2021
9.9.3 941 11/9/2021
9.9.2 665 11/4/2021
9.9.0 757 10/30/2021
9.8.9 698 10/29/2021
9.8.7 655 10/27/2021
9.8.6 651 10/27/2021
9.8.5 715 10/26/2021
9.8.0 1,374 10/20/2021
9.7.9 643 10/19/2021
9.7.5 1,481 10/14/2021
9.7.0 855 10/9/2021
9.6.6 1,225 8/14/2021
9.2.0 388 5/26/2021
9.1.7 6,927 5/3/2021
9.1.4 676 4/21/2021
9.1.0 1,056 4/14/2021
9.0.0 912 4/5/2021
8.9.9 1,011 3/30/2021
8.9.3 1,564 3/19/2021
8.9.2 1,018 1/29/2021
8.9.1 1,018 1/24/2021
8.9.0 1,080 1/22/2021
8.6.9 2,986 11/8/2020
8.6.6 1,961 11/2/2020
8.6.0 4,039 10/28/2020
8.5.0 1,911 10/23/2020
8.4.1 4,862 10/15/2020
8.4.0 1,317 10/13/2020
8.3.1 2,668 10/5/2020
8.3.0 1,256 10/3/2020
8.2.2 2,028 9/26/2020
8.2.1 1,336 9/25/2020
8.2.0 1,390 9/25/2020
8.1.17 6,776 9/13/2020
8.1.16 634 9/13/2020
8.1.15 1,925 9/12/2020
8.1.11 2,518 9/11/2020
8.1.10 1,304 9/6/2020
8.1.9 1,334 9/3/2020
8.1.8 1,299 9/2/2020
8.1.7 1,207 8/28/2020
8.1.4 1,228 8/25/2020
8.1.3 1,255 8/18/2020
8.1.2 1,225 8/16/2020
8.1.1 1,270 8/15/2020
8.1.0 579 8/15/2020
8.0.1 2,678 8/7/2020
8.0.0 1,230 8/7/2020
7.0.1 1,377 6/28/2020
7.0.0 1,371 6/28/2020
5.0.0 7,489 2/25/2020
4.0.4 7,988 1/27/2020
4.0.3 1,243 1/27/2020
4.0.2 1,416 1/16/2020
4.0.1 1,409 1/11/2020
4.0.0 1,342 1/5/2020
3.1.1 4,214 12/4/2019
3.1.0 2,773 11/10/2019
3.0.0 3,920 10/23/2019
2.0.0 6,636 10/18/2019