GitHub

id_generator

API reference for id_generator.

Ids for tool calls and response parts (Effect's IdGenerator).

The default makes id_ and 16 random characters; layer provides one of another alphabet, prefix, separator or size. Ids draw from Random, so a seeded Random makes them reproducible.

Re-exports

Values

AttributeTypeDescription
DEFAULT_ALPHABETLiteral['0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmn…'] = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz'
default_id_generatorService

Classes

Functions

make

make(*, alphabet=DEFAULT_ALPHABET, prefix=None, separator='_', size=16) -> Effect[Service, IllegalArgumentError]

A generator; fails if separator is in alphabet.

ParameterTypeDescription
alphabetstr = DEFAULT_ALPHABET
prefixstr | None = None
separatorstr = '_'
sizeint = 16

Returns Effect[Service, IllegalArgumentError]

def make(
    *,
    alphabet: str = DEFAULT_ALPHABET,
    prefix: str | None = None,
    separator: str = "_",
    size: int = 16,
) -> Effect[Service, IllegalArgumentError]:
    """A generator; fails if ``separator`` is in ``alphabet``."""
    if separator in alphabet:
        message = f'The separator "{separator}" must not be part of the alphabet "{alphabet}".'
        return fx.fail(IllegalArgumentError(message))
    return fx.succeed(_generator(alphabet, prefix, separator, size))

layer

layer(*, alphabet=DEFAULT_ALPHABET, prefix=None, separator='_', size=16) -> L.Layer[IdGenerator, IllegalArgumentError, Never]
ParameterTypeDescription
alphabetstr = DEFAULT_ALPHABET
prefixstr | None = None
separatorstr = '_'
sizeint = 16

Returns L.Layer[IdGenerator, IllegalArgumentError, Never]

def layer(
    *,
    alphabet: str = DEFAULT_ALPHABET,
    prefix: str | None = None,
    separator: str = "_",
    size: int = 16,
) -> L.Layer[IdGenerator, IllegalArgumentError, Never]:
    return L.effect(
        IdGenerator, make(alphabet=alphabet, prefix=prefix, separator=separator, size=size)
    )