API:String

This page contains list of extended String functions.

DISABLING STRING EXTENSION

String extension is enabled by default. However it may be disabled by assigning a global flag AROMANIZE_EXTEND_STRING = false before including aromanize.js. There are also several simpler ways to disable it.

<script type="text/javascript">
    AROMANIZE_EXTEND_STRING = false;
</script>
<script type="text/javascript" src="aromanize.js"></script>

Alternative 1: Add base flag to query string.

<script type="text/javascript" src="aromanize.js?base"></script>

Alternative 2: Require "base" version of the script for Node.js.

var Aromanize = require('aromanize/base');

Please note that when it is disabled, all methods listed here will not be available.

Methods

romanize

since 0.1

romanize(rule = 'rr')

Converts text to Romaja (Latin script).

This is a wrapper function of Aromanize.romanize().

Parameters:

• rule

  String Transliteration rule to use.