Namespace arbitrary

Index

Interfaces Model

Arbitrary

Type aliases Model

URI

Type aliases Other

StringParams

Variables Model

URI

Variables Typeclasses

Functions Apply

ap

Functions Chain

chain

Functions Combinators

Functions Constructors

Functions Destructors

toGen

Functions Functor

map

Functions Other

Functions Pointed

of

Functions Primitives

boolean

Model Type aliases

URI

URI: typeof arbitrary.URI

Other Type aliases

StringParams

StringParams: Partial<Record<"from" | "to", string>>

Model Variables

Const URI

URI: "Arbitrary" = "Arbitrary"

Typeclasses Variables

Const Applicative

Applicative: Applicative1<arbitrary.URI> = ...

Const Apply

Apply: Apply1<arbitrary.URI> = ...

Const Chain

Chain: Chain1<arbitrary.URI> = ...

Const Functor

Functor: Functor1<arbitrary.URI> = ...

Const Pointed

Pointed: Pointed1<arbitrary.URI> = ...

Apply Functions

ap

ap<A>(fa: Arbitrary<A>): <B>(fab: Arbitrary<(a: A) => B>) => Arbitrary<B>

- Defined in packages/core/src/arbitrary.ts:59
Type parameters
- A
Parameters
- fa: Arbitrary<A>
Returns <B>(fab: Arbitrary<(a: A) => B>) => Arbitrary<B>
- - <B>(fab: Arbitrary<(a: A) => B>): Arbitrary<B>
  - Type parameters
    - B
    Parameters
    - fab: Arbitrary<(a: A) => B>
    Returns Arbitrary<B>

Chain Functions

chain

chain<A, B>(f: (a: A) => Arbitrary<B>): (fa: Arbitrary<A>) => Arbitrary<B>

- Defined in packages/core/src/arbitrary.ts:72
Type parameters
- A
- B
Parameters
- f: (a: A) => Arbitrary<B>
  - - (a: A): Arbitrary<B>
    - Parameters
      - a: A
      Returns Arbitrary<B>
Returns (fa: Arbitrary<A>) => Arbitrary<B>
- - (fa: Arbitrary<A>): Arbitrary<B>
  - Parameters
    - fa: Arbitrary<A>
    Returns Arbitrary<B>

Combinators Functions

array

array<A>(arbitrary: Arbitrary<A>): Arbitrary<ReadonlyArray<A>>

- Defined in packages/core/src/arbitrary.ts:230
summary
Generates an array with a random size, then each has the random contents.

Type parameters
- A
Parameters
- arbitrary: Arbitrary<A>
Returns Arbitrary<ReadonlyArray<A>>

filter

filter<A, B>(refinement: Refinement<A, B>): (fa: Arbitrary<A>) => Arbitrary<B>
filter<A>(predicate: Predicate<A>): (fa: Arbitrary<A>) => Arbitrary<A>

- Defined in packages/core/src/arbitrary.ts:201
Arbitrary cannot have a Compactable typeclass instance, as the state needs to be supplied and called before being able to seperate the output conditionally.

Type parameters
- A
- B
Parameters
- refinement: Refinement<A, B>
Returns (fa: Arbitrary<A>) => Arbitrary<B>
- - (fa: Arbitrary<A>): Arbitrary<B>
  - Arbitrary cannot have a Compactable typeclass instance, as the state needs to be supplied and called before being able to seperate the output conditionally.
    
    category
    Combinators
    
    Parameters
    - fa: Arbitrary<A>
    Returns Arbitrary<B>
- Defined in packages/core/src/arbitrary.ts:204
Type parameters
- A
Parameters
- predicate: Predicate<A>
Returns (fa: Arbitrary<A>) => Arbitrary<A>
- - (fa: Arbitrary<A>): Arbitrary<A>
  - Parameters
    - fa: Arbitrary<A>
    Returns Arbitrary<A>

lazy

lazy<A>(lazy: Lazy<Arbitrary<A>>): Arbitrary<A>

- Defined in packages/core/src/arbitrary.ts:190
Allows use of an arbitrary that is used after the current arbitrary is defined. Useful for recursive patterns.

example
const y = AR.lazy(() => x) const x = AR.of(constVoid()) // now y can use x without it being unreachable code

Type parameters
- A
Parameters
- lazy: Lazy<Arbitrary<A>>
Returns Arbitrary<A>

mutable

mutable<A>(fa: Arbitrary<Readonly<A>>): Arbitrary<A>

- Defined in packages/core/src/arbitrary.ts:264
summary
Removes the Readonly type constraint from the value within an Arbitrary instance.

Type parameters
- A
Parameters
- fa: Arbitrary<Readonly<A>>
Returns Arbitrary<A>

nullable

nullable<T>(arbitrary: Arbitrary<T>): Arbitrary<null | T>

- Defined in packages/core/src/arbitrary.ts:156
Allow generating arbitraries of T or null.

Type parameters
- T
Parameters
- arbitrary: Arbitrary<T>
Returns Arbitrary<null | T>

readonly

readonly<A>(fa: Arbitrary<A>): Arbitrary<Readonly<A>>

- Defined in packages/core/src/arbitrary.ts:255
Adds the Readonly type constraint from the value within an Arbitrary instance.

Type parameters
- A
Parameters
- fa: Arbitrary<A>
Returns Arbitrary<Readonly<A>>

struct

struct<R>(struct: EnforceNonEmptyRecord<{ readonly [ P in string | number | symbol]: Arbitrary<R[P]> }>): Arbitrary<{}>

- Defined in packages/core/src/arbitrary.ts:279
Type parameters
- R: Record<string, unknown>
Parameters
- struct: EnforceNonEmptyRecord<{ readonly [ P in string | number | symbol]: Arbitrary<R[P]> }>
Returns Arbitrary<{}>

tuple

tuple<R>(...arbitraries: R): Arbitrary<[...{ [ K in string | number | symbol]: [R[K]] extends [Arbitrary<A>] ? A : never }[]]>

- Defined in packages/core/src/arbitrary.ts:270
Type parameters
- R: readonly [Arbitrary<unknown>, Arbitrary<unknown>, R]
Parameters
- Rest ...arbitraries: R
Returns Arbitrary<[...{ [ K in string | number | symbol]: [R[K]] extends [Arbitrary<A>] ? A : never }[]]>

union

union<T>(...arbitraries: { readonly [ P in string | number | symbol]: Arbitrary<T[P]> }): Arbitrary<T[number]>

- Defined in packages/core/src/arbitrary.ts:288
Type parameters
- T: readonly [unknown, unknown, T]
Parameters
- Rest ...arbitraries: { readonly [ P in string | number | symbol]: Arbitrary<T[P]> }
Returns Arbitrary<T[number]>

vector

vector(size: number): <A>(fa: Arbitrary<A>) => Arbitrary<readonly A[]>

- Defined in packages/core/src/arbitrary.ts:242
Generates an array with a fixed size, then each has the random contents.

Parameters
- size: number
Returns <A>(fa: Arbitrary<A>) => Arbitrary<readonly A[]>
- - <A>(fa: Arbitrary<A>): Arbitrary<readonly A[]>
  - Type parameters
    - A
    Parameters
    - fa: Arbitrary<A>
    Returns Arbitrary<readonly A[]>

Constructors Functions

fromGen

fromGen<A>(gen_: Gen<A>): Arbitrary<A>

- Defined in packages/core/src/arbitrary.ts:117
summary
Lift a generator into the Arbitrary typeclass.

Type parameters
- A
Parameters
- gen_: Gen<A>
Returns Arbitrary<A>

int

int(...a: [{ max?: number; min?: number }?]): Gen<Rose<number>>

- Defined in packages/core/src/arbitrary.ts:139
Parameters
- Rest ...a: [{ max?: number; min?: number }?]
Returns Gen<Rose<number>>

Destructors Functions

toGen

toGen<A>(fa: Arbitrary<A>): Gen<A>

- Defined in packages/core/src/arbitrary.ts:304
Type parameters
- A
Parameters
- fa: Arbitrary<A>
Returns Gen<A>

Functor Functions

map

map<A, B>(f: (a: A) => B): (fa: Arbitrary<A>) => Arbitrary<B>

- Defined in packages/core/src/arbitrary.ts:52
Type parameters
- A
- B
Parameters
- f: (a: A) => B
  - - (a: A): B
    - Parameters
      - a: A
      Returns B
Returns (fa: Arbitrary<A>) => Arbitrary<B>
- - (fa: Arbitrary<A>): Arbitrary<B>
  - Parameters
    - fa: Arbitrary<A>
    Returns Arbitrary<B>

Other Functions

character

character(options?: Partial<Record<"from" | "to", string>>): Arbitrary<string>

- Defined in packages/core/src/arbitrary.ts:143
Parameters
- Optional options: Partial<Record<"from" | "to", string>>
Returns Arbitrary<string>

fromGenK

fromGenK<T, A>(gen_: (...args: T) => Gen<A>): (...args: T) => Arbitrary<A>

- Defined in packages/core/src/arbitrary.ts:121
Type parameters
- T: readonly unknown[]
- A
Parameters
- gen_: (...args: T) => Gen<A>
  - - (...args: T): Gen<A>
    - Parameters
      - Rest ...args: T
      Returns Gen<A>
Returns (...args: T) => Arbitrary<A>
- - (...args: T): Arbitrary<A>
  - Parameters
    - Rest ...args: T
    Returns Arbitrary<A>

fromShrink

fromShrink<A>(f: Shrink<A>): (a: A) => Rose<A>

- Defined in packages/core/src/arbitrary.ts:127
Type parameters
- A
Parameters
- f: Shrink<A>
Returns (a: A) => Rose<A>
- - (a: A): Rose<A>
  - Parameters
    - a: A
    Returns Rose<A>

mk

mk<A>(generator: Gen<A>, shrinker?: Shrink<A>): Arbitrary<A>

- Defined in packages/core/src/arbitrary.ts:131
Type parameters
- A
Parameters
- generator: Gen<A>
- shrinker: Shrink<A> = ...
Returns Arbitrary<A>

string

string(options?: Partial<Record<"from" | "to", string>>): Arbitrary<string>

- Defined in packages/core/src/arbitrary.ts:147
Parameters
- Optional options: Partial<Record<"from" | "to", string>>
Returns Arbitrary<string>

stringNonempty

stringNonempty(options?: Partial<Record<"from" | "to", string>>): Arbitrary<string>

- Defined in packages/core/src/arbitrary.ts:323
Parameters
- Optional options: Partial<Record<"from" | "to", string>>
Returns Arbitrary<string>

Pointed Functions

of

of<A>(a: A): Arbitrary<A>

- Defined in packages/core/src/arbitrary.ts:47
Type parameters
- A
Parameters
- a: A
Returns Arbitrary<A>

Primitives Functions

boolean

boolean(s: GenState): [Rose<boolean>, GenState]

- Defined in packages/core/src/arbitrary.ts:316
Parameters
- s: GenState
Returns [Rose<boolean>, GenState]

Generated using TypeDoc