@solana/codecs-strings/dist/types/null-characters.d.ts

Codecs for strings of different sizes and encodings

/**
 * Removes all null characters (`\u0000`) from a string.
 *
 * This function cleans a string by stripping out any null characters,
 * which are often used as padding in fixed-size string encodings.
 *
 * @param value - The string to process.
 * @returns The input string with all null characters removed.
 *
 * @example
 * Removing null characters from a string.
 * ```ts
 * removeNullCharacters('hello\u0000\u0000'); // "hello"
 * ```
 */
export declare const removeNullCharacters: (value: string) => string;
/**
 * Pads a string with null characters (`\u0000`) at the end to reach a fixed length.
 *
 * If the input string is shorter than the specified length, it is padded with null characters
 * until it reaches the desired size. If it is already long enough, it remains unchanged.
 *
 * @param value - The string to pad.
 * @param chars - The total length of the resulting string, including padding.
 * @returns The input string padded with null characters up to the specified length.
 *
 * @example
 * Padding a string with null characters.
 * ```ts
 * padNullCharacters('hello', 8); // "hello\u0000\u0000\u0000"
 * ```
 */
export declare const padNullCharacters: (value: string, chars: number) => string;
//# sourceMappingURL=null-characters.d.ts.map