@darlean/core/lib/shared.d.ts

Darlean core functionality for creating applications that define, expose and host actors

/**
 * Normalizes an action name for cross-language use. Removes all characters except for
 * a-z, A-Z and 0-9, and converts the resulting value into lowercase.
 * @param name The unnormalized name of the action
 * @returns The normalized action name
 * @remarks Due to the nature of the normalization, casing or use of special characters
 * should not be used to discriminate between two otherwise identical action names. For
 * example, do not define two actions named `makeWarmer` and `makewarmer` on the same actor,
 * because both will normalize to `makewarmer`, which is not allowed.
 */
export declare function normalizeActionName(name: string): string;
/**
 * Normalizes an actor type for cross-language use. Removes all characters except for
 * `a-z`, `A-Z`, `0-9` and `.`, and converts the resulting value into lowercase.
 * @param name The unnormalized actor type
 * @returns The normalized actor type
 * @remarks Due to the nature of the normalization, casing or use of special characters
 * should not be used to discriminate between two otherwise identical actor typess. For
 * example, do not define two actors with type `temperatureActor` and `TemperatureActor`,
 * because both will normalize to `temperatureactor`, which is not allowed.
 */
export declare function normalizeActorType(type: string): string;