ogham/src/ogham.d.ts

convert an input string to its Ogham equivalent

/**
 * Interface representing options that can be passed to the convert
 */
export interface OghamOptions {
  addBoundary?: boolean;
  useForfeda?: boolean;
  usePhonetics?: boolean;
}
/**
 * Given an input of latin characters and spaces, this will return a string
 * containing the corresponding ogham characters, e.g "eire" => "᚛ᚓᚔᚏᚓ᚜"
 * @param text
 * @param headAndTail
 */
export declare function convert(input: string, opts?: OghamOptions): string;