https://github.com/samiahmedsiddiqui/trim-php
Strip whitespace (or other characters) of a string.
https://github.com/samiahmedsiddiqui/trim-php
ltrim nodejs react rtrim trim trim-php trim-string-whitespaces typescript
Last synced: 2 months ago
JSON representation
Strip whitespace (or other characters) of a string.
- Host: GitHub
- URL: https://github.com/samiahmedsiddiqui/trim-php
- Owner: samiahmedsiddiqui
- License: mit
- Created: 2019-10-26T11:46:37.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-05-31T09:38:10.000Z (about 5 years ago)
- Last Synced: 2024-04-24T23:01:53.957Z (about 2 years ago)
- Topics: ltrim, nodejs, react, rtrim, trim, trim-php, trim-string-whitespaces, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/trim-php
- Size: 28.3 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# trim-php
[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![AppVeyor Build Status][appveyor-image]][appveyor-url]
Strip whitespace (or other characters) of a string.
## Install
Via `npm`
```javascript
npm install trim-php
```
Via Yarn
```javascript
yarn add trim-php
```
## Usage
Import Package in `Node.js`.
```javascript
const trimPhp = require('trim-php').default;
```
Import Package in `React`.
```javascript
import trimPhp from 'trim-php';
```
## Examples
### Strip whitespace (or other characters) from the beginning of a string
#### In V1
```javascript
const trim = require('trim-php');
const str = '\n Hello World! \n';
console.log('Without Trim: ', str);
console.log('With lTrim: ', trim.lTrim(str));
```
#### In V2
```javascript
const trimPhp = require('trim-php').default;
const str = '\n Hello World! \n';
console.log('Without Trim: ', str);
console.log('With lTrim: ', new trimPhp().lTrim(str));
```
### Strip whitespace (or other characters) from the end of a string
#### In V1
```javascript
const trim = require('trim-php');
const str = '\n Hello World! \n';
console.log('Without Trim: ', str);
console.log('With rTrim: ', trim.rTrim(str));
```
#### In V2
```javascript
const trimPhp = require('trim-php').default;
const str = '\n Hello World! \n';
console.log('Without Trim: ', str);
console.log('With rTrim: ', new trimPhp().rTrim(str));
```
### Strip whitespace (or other characters) from the beginning and end of a string
#### In V1
```javascript
const trim = require('trim-php');
const str = '\n Hello World! \n';
console.log('Without Trim: ', str);
console.log('With trimPhp: ', trim.trimPhp(str));
```
#### In V2
```javascript
const trimPhp = require('trim-php').default;
const str = '\n Hello World! \n';
console.log('Without Trim: ', str);
console.log('With trim: ', new trimPhp().trim(str));
```
### Strip whitespace (or other characters) from the beginning and end of a string in React
#### In V1
```javascript
import trim from 'trim-php';
var str = '\n Hello World! \n';
console.log('Without Trim: ', str);
console.log('With trimPhp: ', trim.trimPhp(str));
```
#### In V2
```jsx
import trimPhp from 'trim-php';
const str = '\n Hello World! \n';
console.log('Without Trim: ', str);
console.log('With trimPhp: ', new trimPhp().trim(str));
```
## Parameters
| Attributes | Type | Required | Description |
|------------|:------:|:--------:|-------------------------------------------------------|
| str | String | Yes | Specifies the string to check. |
| charList | String | No | Specifies which characters to remove from the string. |
## Return
Returns the modified string.
## Tested
This package is tested with the `Node.js` and `React` Application.
[npm-image]: https://img.shields.io/npm/v/trim-php.svg
[npm-url]: https://www.npmjs.com/package/trim-php
[downloads-image]: https://img.shields.io/npm/dm/trim-php.svg
[travis-image]: https://img.shields.io/travis/com/samiahmedsiddiqui/trim-php.svg?label=travis-ci
[travis-url]: https://travis-ci.com/samiahmedsiddiqui/trim-php
[appveyor-url]: https://ci.appveyor.com/project/samiahmedsiddiqui/trim-php
[appveyor-image]: https://img.shields.io/appveyor/ci/samiahmedsiddiqui/trim-php.svg?label=appveyor