Header menu logo ananoid

Core Module

Contains simple functions for generating 'nano identifier' strings (a simple alternative to things like 'Universal Unique Identifiers').

Nested modules

Modules Description

Alphabets

Pre-defined alphabets commonly used to generate identifiers.

Defaults

Defines the recommended set of characters and output length for optimally generating nano identifier strings.

Tagged

Contains primitives for generating identifiers which are "tagged" with a discriminator (useful for managing lots of string which have different purposes, but where using a full CLR type is undesirable).

Functions and values

Function or value Description

nanoId ()

Full Usage: nanoId ()

Parameters:
    () : unit

Returns: string

Generates a new identifier with the default alphabet and size.

When viewed from other languages, this function is named NewNanoId.

() : unit
Returns: string

nanoIdOf alphabet size

Full Usage: nanoIdOf alphabet size

Parameters:
    alphabet : string
    size : int

Returns: string

Generates a new identifier, size characters in length, derived from the letters of the given alphabet (note: a size of less than one will result in an empty string).

When viewed from other languages, this function is named NewNanoId.

alphabet : string
size : int
Returns: string
ArgumentOutOfRangeException Thrown when alphabet contains < 1 letter, or > 255 letters.

Type something to start searching.