Manipulate plain text strikethrough chars in Javascript
\n
\n \n
\n\n## Why?\nThis library aims to help you **manipulate strikethrough characters** in strings.\n\n### What is strikethrough text?\n> Strikethrough is represented by words with a horizontal line through their center. It implies that the text is wrong and was recently deleted or marked as such. Unlike the HTML's tag, strikethrough text will work when you copy-paste it in to another location. That’s because the strikethrough characters [...] are in plain text. - [Saijo George](https://saijogeorge.com/strikethrough-text-generator/)\n\n### An example\nIt can be useful when some fonts don't support strikethrough text. Using this, you will be able to use regular text and then apply strikethrough another way (e.g., in CSS: `text-decoration: line-through;`).\n\n## Get started\n### Install\n```sh\nnpm install strikethrough-js\n```\n\n### Use\n```javascript\n// Common\nvar strikethrough = require('strikethrough-js');\nvar res = strikethrough.removeStrikethrough('m̶y̶T̶e̶x̶t̶');\n\n// ES5/6\nimport { removeStrikethrough } from 'strikethrough-js';\nconst res = removeStrikethrough('m̶y̶T̶e̶x̶t̶');\n```\n\n## Utils\n### `removeStrikethrough`\nReturns an equivalent `string` of regular text:\n```javascript\nconst str = removeStrikethrough('Price was 1̶2̶3̶7̶8̶9̶€̶');\n// Price was 123789€\n```\n\n### `removeStrikethroughChars`\nReturns a `string ` without strikethrough text:\n```javascript\nconst str = removeStrikethroughChars('456€ 1̶2̶3̶7̶8̶9̶€̶');\n// 456€ \n```\n\n### `getStrikethroughChars`\nReturns a `string[]` of the strikethrough characters:\n```javascript\nconst str = getStrikethroughChars('456€ (1̶2̶3̶7̶8̶9̶€̶)');\n// [\"1̶\", \"2̶\", \"3̶\", \"7̶\", \"8̶\", \"9̶\", \"€̶\"]\n```\n\n### `getStrikethroughString`\nReturns a `string` of the strikethrough text:\n```javascript\nconst str = getStrikethroughString('456€ (1̶2̶3̶7̶8̶9̶€̶)');\n// 1̶2̶3̶7̶8̶9̶€̶\n```\n\n### `getChars`\nReturns an equivalent `string[]` of the strikethrough characters:\n```javascript\nconst str = getChars('456€ (1̶2̶3̶7̶8̶9̶€̶)');\n// [\"1\", \"2\", \"3\", \"7\", \"8\", \"9\", \"€\"]\n```\n\n### `getString`\nReturns an equivalent `string` of the strikethrough characters:\n```javascript\nconst str = getString('456€ (1̶2̶3̶7̶8̶9̶€̶)');\n// 123789€\n```\n\n## Contribute\n### Library\nSince this `lib` is pretty light, there is no need for a sophisticated bundler (like Webpack or Rollup). The core `lib` is bundled with bare-bones [NodeJS](https://nodejs.org/en/) and [Babel](https://babeljs.io/).\n \n### Tests\n```npm\nnpm test\n```\nWill run [Jest](https://jestjs.io/) test suites. It will be also triggered by [Husky](https://github.com/typicode/husky) git hooks.\n","readmeFilename":"README.md"}
![\"strikethrough-js\"](\"https://i.imgur.com/5260wcO.gif\")
\n![\"npm](\"https://badge.fury.io/js/strikethrough-js.svg\"){kind=icon}
\n