Class Basura

Create garbage javascript types for testing.

Constructors

constructor

new Basura(
    opts?: {
        arrayLength?: number;
        cborSafe?: boolean;
        depth?: number;
        edgeFreq?: number;
        fakeSymbols?: boolean;
        jsonSafe?: boolean;
        noBoxed?: boolean;
        output?: boolean;
        randBytes?: RandBytes;
        scripts?: string[];
        stringLength?: number;
        types?: Record<string, BasuraGenerator<unknown>>;
    },
): Basura
Create some Basura.
Parameters
- Optionalopts: {
      arrayLength?: number;
      cborSafe?: boolean;
      depth?: number;
      edgeFreq?: number;
      fakeSymbols?: boolean;
      jsonSafe?: boolean;
      noBoxed?: boolean;
      output?: boolean;
      randBytes?: RandBytes;
      scripts?: string[];
      stringLength?: number;
      types?: Record<string, BasuraGenerator<unknown>>;
  } = {}
  Options.
  - OptionalarrayLength?: number
    Maximum size of arrays and objects.
  - OptionalcborSafe?: boolean
    Generate only CBOR-safe types?
  - Optionaldepth?: number
    Maximum depth of object to create.
  - OptionaledgeFreq?: number
    How often do edge cases happen (0-1)?
  - OptionalfakeSymbols?: boolean
    Instead of generating symbols, generate an object that will inspect as Symbol.for('string').
  - OptionaljsonSafe?: boolean
    Generate only JSON-safe types?
  - OptionalnoBoxed?: boolean
    Ignore boxed types, like String?
  - Optionaloutput?: boolean
    Add custom inspect functions that make output parseable JS?
  - OptionalrandBytes?: RandBytes
    Randomness source. Defaults to a thin wrapper around crypto.randomBytes.
  - Optionalscripts?: string[]
    List of script names to select from for generating strings. Defaults to all Unicode scripts from data.json.
  - OptionalstringLength?: number
    Maximum size of generated strings. (in codepoints), BigInts (in bytes), and buffers (in bytes).
  - Optionaltypes?: Record<string, BasuraGenerator<unknown>>
    Additional types. The key is the type name, the value is a function used to generate, or null to prevent that type from being generated.
Returns Basura
- Defined in index.js:170

Properties

`Static`annotations

annotations: [string, ...MethodDecorator[]][] = ...

ErrorConstructors

ErrorConstructors: (ErrorConstructor | AggregateErrorConstructor)[]

functionSpecies

functionSpecies: string[]

funNumbers

funNumbers: number[]

opts

opts: {
    arrayLength: number;
    catchUnhandled: boolean;
    cborSafe: boolean;
    depth: number;
    edgeFreq: number;
    fakeSymbols: boolean;
    jsonSafe: boolean;
    noBoxed: boolean;
    output: boolean;
    randBytes: RandBytes;
    scripts: any;
    stringLength: number;
    types: Record<string, BasuraGenerator<unknown>>;
}

typedArrays

typeNames

typeNames: string[]

types

types: Record<string, BasuraGenerator<unknown>>

validWeak

validWeak: string[]

weakMembers

weakMembers: WeakMap<any, any[]>

Methods

generate

generate(depth?: number): any
Generate a random type that this object currently supports. Returns null if we're already too deep.
Parameters
- Optionaldepth: number = 0
  How deep are we in the generated tree of objects already?
Returns any
Might generate... Anything!
- Defined in index.js:1095

generate_Array

generate_Array(depth?: number): any[]
Generate an Array of up to arrayLength size, with each element of the array being generated from the list of types this object currently supports. Generates an empty array ([]) if we're too deep already.
Parameters
- Optionaldepth: number = 0
  How deep are we in the generated tree of objects already?
Returns any[]
Generated array.
- Defined in index.js:607

generate_bigint

generate_bigint(depth?: number): bigint
Generate a random BigInt of up to stringLength bytes.
Parameters
- Optionaldepth: number = 0
  How deep are we in the generated tree of objects already?
Returns bigint
Generated BigInt, possibly negative.
- Defined in index.js:712

generate_boolean

generate_boolean(_depth?: number, reason?: string): boolean
Generate boolean.
Parameters
- Optional_depth: number = 0
  How deep are we in the generated tree of objects already?
- Optionalreason: string = 'boolean'
  Reason for generating bool.
Returns boolean
True or false.
- Defined in index.js:337

generate_Boolean

generate_Boolean(_depth?: number): boolean
Generate boxed Boolean.
Parameters
- Optional_depth: number = 0
  How deep are we in the generated tree of objects already?
Returns boolean
New Boolean(true) or new Boolean(false).
- Defined in index.js:348

generate_Buffer

generate_Buffer(depth?: number): Buffer<ArrayBufferLike>
Generate a Buffer of up to stringLength size.
Parameters
- Optionaldepth: number = 0
  How deep are we in the generated tree of objects already?
Returns Buffer<ArrayBufferLike>
NodeJS Buffer.
- Defined in index.js:416

generate_Date

generate_Date(_depth?: number): Date
Generate a random Date, gaussian-distributed around today with a standard deviation of 10 years.
Parameters
- Optional_depth: number = 0
  How deep are we in the generated tree of objects already?
Returns Date
Generated Date.
- Defined in index.js:729

generate_Error

generate_Error(depth?: number): Error
Generate a random Error. If an AggregateError is selected, fill it with random Errors.
Parameters
- Optionaldepth: number = 0
  How deep are we in the generated tree of objects already?
Returns Error
Generated Error.
- Defined in index.js:755

generate_function

generate_function(depth?: number): Function
Generate a function of a random "species". The current species list is stored in this.functionSpecies. See tutorial for more information. If we are already too deep, generates () => {}.
Parameters
- Optionaldepth: number = 0
  How deep are we in the generated tree of objects already?
Returns Function
Generated function.
- Defined in index.js:973

generate_Generator

generate_Generator(depth?: number): Generator<any, any, any>
Generate a generator that yields basura.
Parameters
- Optionaldepth: number = 0
  How deep are we in the generated tree of objects already?
Returns Generator<any, any, any>
Generated.
- Defined in index.js:1075

generate_integer

generate_integer(_depth?: number): number
Generate signed 32-bit integer. Note: may be folded into generate_number later.
Parameters
- Optional_depth: number = 0
  How deep are we in the generated tree of objects already?
Returns number
32-bit integer.
- Defined in index.js:366

generate_Map

generate_Map(depth?: number): Map<any, any>
Generate a random Map with up to arrayLength elements. If we are too deep already, will generate an empty Map. Each key and value will be of a random type currently supported by this object.
Parameters
- Optionaldepth: number = 0
  How deep are we in the generated tree of objects already?
Returns Map<any, any>
Generated Map.
- Defined in index.js:899

generate_number

generate_number(_depth?: number): number
Generate 64-bit floating point number, with a 10% chance of something "fun": 0, -0, NaN, Infinity, -Infinity.
Parameters
- Optional_depth: number = 0
  How deep are we in the generated tree of objects already?
Returns number
Number or edge case.
- Defined in index.js:378

generate_Number

generate_Number(_depth?: number): number
Generate boxed 64-bit floating point Number, with a 10% chance of something "fun": 0, -0, NaN, Infinity, -Infinity.
Parameters
- Optional_depth: number = 0
  How deep are we in the generated tree of objects already?
Returns number
Wrapped new Number(num).
- Defined in index.js:398

generate_Object

generate_Object(depth?: number): any
Generate a random object with up to arrayLength properties. Will generate null (an Object!) if we are too deep already.
Parameters
- Optionaldepth: number = 0
  How deep are we in the generated tree of objects already?
Returns any
Object or null.
- Defined in index.js:693

generate_Promise

generate_Promise(depth?: number): Promise<any>
Generate a rejected or resolved promise.
Parameters
- Optionaldepth: number = 0
  How deep are we in the generated tree of objects already?
Returns Promise<any>
Resolved or rejected promise.
- Defined in index.js:793

generate_Proxy

generate_Proxy(depth?: number): ProxyConstructor
Generate a Proxy over a random object. If we are already too deep, generates a Proxy around {}.
Parameters
- Optionaldepth: number = 0
  How deep are we in the generated tree of objects already?
Returns ProxyConstructor
Plain object in output mode, otherwise Proxy.
- Defined in index.js:925

generate_RegExp

generate_RegExp(depth?: number): RegExp
Generate a regular expression of up to stringLength size, all from the same random Unicode script. The first codepoint will not be a combining character.
Parameters
- Optionaldepth: number = 0
  How deep are we in the generated tree of objects already?
Returns RegExp
Generated regexp.
- Defined in index.js:488

generate_Set

generate_Set(depth?: number): Set<any>
Generate a Set of random things, with length up to arrayLength, and each element being any one of the types this object currently supports. If we are already too deep, generates an empty set.
Parameters
- Optionaldepth: number = 0
  How deep are we in the generated tree of objects already?
Returns Set<any>
Generated Set.
- Defined in index.js:949

generate_string

generate_string(_depth?: number, reason?: string): string
Generate a string of up to stringLength size, all from the same random Unicode script. The first codepoint will not be a combining character.
Parameters
- Optional_depth: number = 0
  How deep are we in the generated tree of objects already?
- Optionalreason: string = 'string'
  Reason for generation, since this function is called by others.
Returns string
Generated string.
- Defined in index.js:440

generate_String

generate_String(depth?: number): string
Generate a boxed String of up to stringLength size, all from the same random Unicode script. The first codepoint will not be a combining character.
Parameters
- Optionaldepth: number = 0
  How deep are we in the generated tree of objects already?
Returns string
Wrapped new String().
- Defined in index.js:469

generate_symbol

generate_symbol(depth?: number): symbol | FakeSymbol
Generate a symbol from a random string. This will intern the Symbol with Symbol.for to make testing possible.
Parameters
- Optionaldepth: number = 0
  How deep are we in the generated tree of objects already?
Returns symbol | FakeSymbol
Generated Symbol.
- Defined in index.js:883

generate_TypedArray

generate_TypedArray(
    depth?: number,
):
    | ArrayBuffer
    | SharedArrayBuffer
    | DataView<ArrayBufferLike>
    | Int8Array<ArrayBufferLike>
    | Uint8Array<ArrayBufferLike>
    | Uint8ClampedArray<ArrayBufferLike>
    | Int16Array<ArrayBufferLike>
    | Uint16Array<ArrayBufferLike>
    | Int32Array<ArrayBufferLike>
    | Uint32Array<ArrayBufferLike>
    | Float32Array<ArrayBufferLike>
    | Float64Array<ArrayBufferLike>
    | BigInt64Array<ArrayBufferLike>
    | BigUint64Array<ArrayBufferLike>
Generate one of the TypedArrays, ArrayBuffer, SharedArrayBuffer, or DataView of arrayLength elements. If we're too deep already, generate an array with length 0.
Parameters
- Optionaldepth: number = 0
  How deep are we in the generated tree of objects already?
Returns
    | ArrayBuffer
    | SharedArrayBuffer
    | DataView<ArrayBufferLike>
    | Int8Array<ArrayBufferLike>
    | Uint8Array<ArrayBufferLike>
    | Uint8ClampedArray<ArrayBufferLike>
    | Int16Array<ArrayBufferLike>
    | Uint16Array<ArrayBufferLike>
    | Int32Array<ArrayBufferLike>
    | Uint32Array<ArrayBufferLike>
    | Float32Array<ArrayBufferLike>
    | Float64Array<ArrayBufferLike>
    | BigInt64Array<ArrayBufferLike>
    | BigUint64Array<ArrayBufferLike>
Generated TypedArray.
- Defined in index.js:642

generate_undefined

generate_undefined(_depth?: number): undefined
Generate undefined.
Parameters
- Optional_depth: number = 0
  How deep are we in the generated tree of objects already?
Returns undefined
Always returns undefined.
- Defined in index.js:325

generate_URL

generate_URL(depth?: number): URL
Generate a URL object where each component can be up to stringLength size, and each component is all from the same random Unicode script. The top-level domain (TLD) name will be valid, and the preceding domain label will be from the same script as the TLD.

However, that means you'll see a lot of Punycode, thanks to the way that the URL class works.
Parameters
- Optionaldepth: number = 0
  How deep are we in the generated tree of objects already?
Returns URL
Generated punycode URL.
- Defined in index.js:520

generate_WeakMap

generate_WeakMap(depth?: number): WeakMap<any, any>
Generate a WeakMap containing 0 or more key/value pairs where the keys are valid weak items, and the values can be any valid type.
Parameters
- Optionaldepth: number = 0
  How deep are we in the generated tree of objects already?
Returns WeakMap<any, any>
Generated.
- Defined in index.js:844

generate_WeakRef

generate_WeakRef(depth?: number): WeakRef<any>
Parameters
- depth: number = 0
Returns WeakRef<any>
- Defined in index.js:864

generate_WeakSet

generate_WeakSet(depth?: number): WeakSet<any>
Generate a WeakSet containing 0 or more sub-items of any valid type.
Parameters
- Optionaldepth: number = 0
  How deep are we in the generated tree of objects already?
Returns WeakSet<any>
Generated.
- Defined in index.js:820

Class Basura

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

OptionalarrayLength?: number

OptionalcborSafe?: boolean

Optionaldepth?: number

OptionaledgeFreq?: number

OptionalfakeSymbols?: boolean

OptionaljsonSafe?: boolean

OptionalnoBoxed?: boolean

Optionaloutput?: boolean

OptionalrandBytes?: RandBytes

Optionalscripts?: string[]

OptionalstringLength?: number

Optionaltypes?: Record<string, BasuraGenerator<unknown>>

Returns Basura

Properties

Staticannotations

ErrorConstructors

functionSpecies

funNumbers

opts

typedArrays

typeNames

types

validWeak

weakMembers

Methods

generate

Parameters

Returns any

generate_Array

Parameters

Returns any[]

generate_bigint

Parameters

Returns bigint

generate_boolean

Parameters

Returns boolean

generate_Boolean

Parameters

Returns boolean

generate_Buffer

Parameters

Returns Buffer<ArrayBufferLike>

generate_Date

Parameters

Returns Date

generate_Error

Parameters

Returns Error

generate_function

Parameters

Returns Function

generate_Generator

Parameters

Returns Generator<any, any, any>

generate_integer

Parameters

Returns number

generate_Map

Parameters

Returns Map<any, any>

generate_number

Parameters

Returns number

generate_Number

Parameters

Returns number

generate_Object

Parameters

Returns any

generate_Promise

Parameters

`Optional`arrayLength?: number

`Optional`cborSafe?: boolean

`Optional`depth?: number

`Optional`edgeFreq?: number

`Optional`fakeSymbols?: boolean

`Optional`jsonSafe?: boolean

`Optional`noBoxed?: boolean

`Optional`output?: boolean

`Optional`randBytes?: RandBytes

`Optional`scripts?: string[]

`Optional`stringLength?: number

`Optional`types?: Record<string, BasuraGenerator<unknown>>

`Static`annotations