@inntechcorp/it-design 2.0.216 → 2.0.218

package/dist/helpers/format/ToKebabCase.d.ts

@@ -1 +1,27 @@
-export default function toKebabCase(value: string): string;
+/**
+ * What are SEO stop words?
+ *
+ * SEO stop words (Google stop words, stopwords) are generic common words
+ * (and, or, besides, in, a, the, do, they, etc.) that Google may omit in
+ * search query processing because they don’t usually affect the meaning of the query.
+ * These words are actually used for grammatical purposes and don’t communicate a message on their own.
+ *
+ * For example, if you google something like “best carrot cake recipe” and “the best carrot cake recipe”,
+ * the SERP will anyway feature links to pages with carrot cake recipes. In this case, the does not
+ * add any meaning to the query.
+ *
+ */
+/**
+ *
+ * ### toKebabCase
+ *
+ * First, removes special characters from the provided string value and converts it to lowercase.
+ *
+ * @param value             The input string.
+ * @param removeStopWords   Removes stop words if true.
+ * @param removeNumbers     Removes numbers if true.
+ *
+ * @returns If `toKebabCase("bu 123 bir örnek 456 cümle", true, true)` is provided, it will return `"ornek-cumle"`.
+ *
+ */
+export default function toKebabCase(value: string, removeStopWords?: boolean, removeNumbers?: boolean): string;