hkt-toolbelt/digit-list/multiply-digit.d.ts

Functional and composable type utilities

import { Digit, DigitList, Kind, Type } from '..';
type _$multiplyDigit2<A extends DigitList.DigitList, B extends Digit.Digit, CARRY extends Digit.Digit = '0', OUT extends DigitList.DigitList = [], LAST_A extends Digit.Digit = DigitList._$last<A>, POP_A extends DigitList.DigitList = DigitList._$pop<A>, MUL_ONE extends Digit.Digit = Digit._$multiply<LAST_A, B>, MUL_TEN extends Digit.Digit = Digit._$multiplyTens<LAST_A, B>, MUL_CARRY_ONE extends Digit.Digit = Digit._$add<MUL_ONE, CARRY>, MUL_CARRY_TEN extends Digit.Digit = Digit._$addTens<MUL_ONE, CARRY>, NEXT_CARRY extends Digit.Digit = Digit._$add<MUL_TEN, MUL_CARRY_TEN>, NEXT_OUT extends DigitList.DigitList = [MUL_CARRY_ONE, ...OUT], RESULT extends DigitList.DigitList = CARRY extends '0' ? OUT : [CARRY, ...OUT]> = A extends [] ? RESULT : _$multiplyDigit2<POP_A, B, NEXT_CARRY, NEXT_OUT>;
/**
 * `_$multiplyDigit` is a type-level function that multiplies a digit list by a
 * single digit.
 *
 * Returns the result of the multiplication operation.
 *
 * @template A - The digit list.
 * @template B - The single digit.
 *
 * @example
 * For example, we can use `_$multiplyDigit` to multiply a digit list by a
 * single digit:
 *
 * ```ts
 * import { DigitList } from "hkt-toolbelt";
 *
 * type Result = DigitList._$multiplyDigit<["3"], "2">; // ["6"]
 * ```
 *
 * In this example, `Result` is a type that represents ["6"], which is the
 * result of multiplying ["3"] by "2".
 *
 */
export type _$multiplyDigit<A extends DigitList.DigitList, B extends Digit.Digit> = B extends '0' ? ['0'] : _$multiplyDigit2<A, B>;
interface MultiplyDigit_T<T extends Digit.Digit> extends Kind.Kind {
    f(x: Type._$cast<this[Kind._], DigitList.DigitList>): _$multiplyDigit<typeof x, T>;
}
/**
 * `MultiplyDigit` is a type-level function that multiplies a digit list by a
 * single digit.
 *
 * Returns the result of the multiplication operation.
 *
 * @template A - The digit list.
 * @template B - The single digit.
 *
 * @example
 * For example, we can use `MultiplyDigit` to multiply a digit list by a single
 * digit:
 *
 * ```ts
 * import { $, DigitList } from "hkt-toolbelt";
 *
 * type Result = $<$<DigitList.MultiplyDigit, "2">, ["3"]>; // ["6"]
 * ```
 *
 * In this example, `Result` is a type that represents ["6"], which is the
 * result of multiplying ["3"] by "2".
 */
export interface MultiplyDigit extends Kind.Kind {
    f(x: Type._$cast<this[Kind._], Digit.Digit>): MultiplyDigit_T<typeof x>;
}
export {};