/typical/mod.ts | rimbu@0.13.1

import * as rimbu from "https://deno.land/x/rimbu@0.13.1/typical/mod.ts";

Namespaces

N Num
N Str
N StrNum
N U

Type Aliases

T Num.Add	Returns the sum of given numbers.
T Num.Decr	Decreases a positive number by 1, or if the number is not positive, returns never.
T Num.Div	Returns the result of dividing the first given natural number by the second.
T Num.DivMod	Returns a tuple containing the quotient and remainer of dividing the first number by the second.
T Num.Equal	Returns true if the given numbers are equal.
T Num.GreaterThan	Returns true if the first given number is greater than the second.
T Num.GreaterThanOrEqual	Returns true if the given first natural number is greater or equal than the second. Returns never otherwise.
T Num.Inc	Add 1 to the given natural number.
T Num.InRange	Returns true if the given number is greater than or equal to given L, and less than or equal to given H, and returns false otherwise.
T Num.IsEven	Returns true if the given natural number is even, or never otherwise.
T Num.IsNatural	Returns true if the given number is a natural number (>= 0), false otherwise
T Num.IsNegative	Returns true if the given number is negative (< 0), false otherwise.
T Num.IsOdd	Returns true if the given natural number is odd, or never otherwise.
T Num.IsPositive	Returns true if the given number is positive (> 0), false otherwise
T Num.LessThan	Returns true if the first given number is less than the second.
T Num.LessThanOrEqual	Returns true if the first given number is less than or equal to the second.
T Num.Max	Returns the largest of the given 2 natural numbers, of never otherwise
T Num.Min	Returns the smallest of the given 2 natural numbers, of never otherwise
T Num.Mod	Returns the remainder after dividing the first given natural number by the second.
T Num.Mult	Returns the result of multiplying the given natural numbers.
T Num.NotEqual	Returns true if the given numbers are not equal.
T Num.Pow	Returns the power of the first natural number to the second given natural number.
T Num.Subtract	Returns the result of subtracting N2 from N1.
T Str.Append	Convenience type to represent the concatenation of two string types.
T Str.AppendTwo	Convenience type to represent the concatenation of three string types.
T Str.CharAt	Returns the character in the given string at the given Index, or false if the index is out of bounds.
T Str.Contains	Returns true if the given string contains the given Amount (default 1) of Sub types.
T Str.Count	Returns the amount of times the given `Sub` type is encountered in the given string.
T Str.Drop	Returns the given string without the first N characters, or an empty string if the string has less characters.
T Str.DropStrict	Returns the given string without the first N characters, or false if the string has less characters.
T Str.DropWhile	Skips part of the string as long as its parts match Sub.
T Str.EndsWith	If the given string does not end with the given `End` type, returns false. Otherwise, returns a tuple containing the start and the matched end.
T Str.Filter	Returns a string containing all the elements that match the given Sub type.
T Str.FilterNot	Returns a string containing all the elements that do not match the given Sub type.
T Str.First	Returns the first character of the given string, or false if the string is empty.
T Str.Init	Returns all but the last character of the given string, or false if the string is empty.
T Str.IsNonEmptyString	Returns false if the given string is empty, true otherwise.
T Str.Last	Returns the last character of the given string, or false if the string if empty.
T Str.Length	Returns the length of the given string S.
T Str.NonEmptyString	Returns never if the given string is empty, otherwise the given string.
T Str.NotContains	Returns true if the given string does not contain the given Amount (default 1) of Sub types.
T Str.RepeatAtLeastTimes	Returns a tuple containing the matched part and the rest of the given string if the string start repeats the given Sub at least N times.
T Str.RepeatAtMostTimes	Returns a tuple containing the matched part and the rest of the given string if the string start repeats the given Sub at most N times.
T Str.RepeatExactTimes	Returns a tuple containing the matched part and the rest of the given string if the string start repeats the given Sub exactly N times.
T Str.RepeatTimes
T Str.ReplaceAll	Replaces, in the given string, all matches with Sub with the given Repl.
T Str.ReplaceFirst	Replaces, in the given string, the first match with Sub with the given Repl. Returns never if there was no match.
T Str.ReplaceLast	Replaces, in the given string, the last match with Sub with the given Repl. Returns never if there was no match.
T Str.Reverse	Returns the given string reversed.
T Str.SplitAt	Returns false if the given string does not contain the given `Middle` type, or a 3-tuple containing the start, the matched middle, and the rest.
T Str.StartsWith	If the given string does not start with the given `Start` type, returns false. Otherwise, returns a tuple containing the matched start and the rest.
T Str.Tail	Returns all but the first character of the given string, or false if the string is empty.
T Str.Take	Returns the first N characters of the given string, or the given string if it does not have enough characters.
T Str.TakeStrict	Returns the first N characters of the given string, or false if the string does not have enough characters.
T Str.TakeWhile	Returns part of the string as long as its parts match Sub.
T StrNum.Add	Returns the result of adding the two given string-numbers.
T StrNum.AddDigit	Given two string digits, this type returns a tuple of which the first element is the digit resulting from addition of the two digits, and the second element is a boolean indicating whether there was an overflow.
T StrNum.AmountTimesIn
T StrNum.AppendDigit
T StrNum.BuildTuple	Builds a tuple of the length of a given string-number. The length can be used to convert a string-number to a number.
T StrNum.Digit	All numeric digits as strings
T StrNum.DigitToTup	A table from StringDigits to an array that repeats the elements of given array T digit amount of times. 'deca' is used to represent an exponent of 10
T StrNum.Divide
T StrNum.FromNumber	Converts a natural number to a string-number, otherwise never.
T StrNum.IsEven	Type that validates whether a given string-number is even. Checks that the last digit is even.
T StrNum.IsNatNum	Returns true if the given string is a valid natural number, false otherwise.
T StrNum.IsOdd	Type that validates whether a given string-number is odd. Checks that the last digit is odd.
T StrNum.IsPosNum	Returns true if the given string is a valid positive integer, false otherwise.
T StrNum.Mult
T StrNum.MultDigit	Returns the result of multiplying the given string number with the given digit.
T StrNum.NatNum	Type that will return the incoming type if the value is a valid natural number, or `never` otherwise.
T StrNum.PosDigit	Positive numeric digits as strings
T StrNum.PosNum	Type that will return the incoming type if the value is a valid positive integer, or `never` otherwise.
T StrNum.SubDigit	Given two string digits, returns a tuple of which the first element is the resulting digit from subtracting the second from the first, and the second element a boolean that is true if there is an 'underflow' or borrow, never otherwise.
T StrNum.Subtract	Returns the result of subtracting the second from the first given string-number, or never if the second value is greater than the first. (Only natural numbers currently supported)
T StrNum.SymTup	A symmetric tuple, where the order or the elements does not matter. As an example: SymTup<'a', 1> is equal to SymTup<1, 'a'>
T StrNum.ToNumber	Converts the given string-number to its corresponding number.
T StrNum.TupleLength	Infers and returns the length of given Tuple T.
T U.Check	Returns never if the given type is false, otherwise unknown.
T U.Extends	If A extends B, returns Then (default true) or else Else (default false)
T U.Not	Returns true if the input type is false, and false if the input type is true.
T U.NotExtends	If A does not extend B, returns Then (default true) or else Else (default false)
T U.Pred	Returns false is the given type is false, true otherwise.
T U.Validate	Returns never if the given type is false, otherwise true.