Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(text): add module doc #4812

Merged
merged 5 commits into from
May 22, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions text/mod.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,31 @@
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
// This module is browser compatible.

/**
* @module
* Utility functions for working with text.
*
* There are various functions for manipulating text, such as `toCamelCase`:
*
* ```ts
* import { toCamelCase } from "@std/text/case";
*
* console.log(toCamelCase("snake_case")); // "snakeCase"
* ```
*
* Or for comparing strings:
*
* ```ts
* import { compareSimilarity } from "@std/text/compare-similarity";
* const words = ["hi", "hello", "help"];
*
* // words most-similar to "hep" will be at the front
* words.sort(compareSimilarity("hep"));
* ```
*
* This module is browser compatible.
*/

export * from "./levenshtein_distance.ts";
export * from "./closest_string.ts";
export * from "./compare_similarity.ts";
Expand Down
Loading