Current section
Files
Jump to
Current section
Files
src/houdini.gleam
@target(javascript)
import houdini/internal/escape_js as escape
@target(erlang)
import houdini/internal/escape_erl as escape
/// Escapes a string to be safely used inside an HTML document by escaping
/// the following characters:
/// - `<` becomes `<`
/// - `>` becomes `>`
/// - `&` becomes `&`
/// - `"` becomes `"`
/// - `'` becomes `'`.
///
/// ## Examples
///
/// ```gleam
/// assert escape("wibble & wobble") == "wibble & wobble"
/// assert escape("wibble > wobble") == "wibble > wobble"
/// ```
///
pub fn escape(string: String) -> String {
escape.escape(string)
}