Persian Tools - v3.5.2

Index

Enumerations Plate

PlateTypes

Classes

Bill

Interfaces Bank account

Interfaces National id

IPlaceByNationalId

Interfaces Number conversion

WordsToNumberOptions

Interfaces Other

Interfaces Phone number

OperatorModel

Interfaces Plate

Type Aliases Other

Type Aliases Plate

Variables

Functions Bank account

Functions Digits

Functions Legal id

verifyIranianLegalId

Functions National id

Functions Number conversion

wordsToNumber

Functions Other

Functions Phone number

Functions timeAgo

timeAgo

Other Type Aliases

DigitsConverter

DigitsConverter<I, O>: ((value: I) => O)

Type Parameters

I = string
O = string

Type declaration

- (value: I): O
- Parameters
  - value: I
  Returns O

ShebaMapCodes

ShebaMapCodes: Record<string, ShebaResult>

Plate Type Aliases

PlateOptions

PlateOptions: string | PlateApi

PlateResultApiTypeString

PlateResultApiTypeString: keyof typeof PlateTypes

Variables

Const acceptableKeywords

acceptableKeywords: RegExp = ...

Acceptable keywords between numbers are:

Star -> *
Underscore -> _
Dash -> -
Dot -> .

example:: 5022*2910_7087-3466
constant

Const cardNumberRegex

cardNumberRegex: RegExp = ...

This Regex can find all kind of Iranian Banks' card number into a text such as these models:

6219-8610-3452-9007
5022291070873466
۵۰۲۲۲۹۱۰۸۱۸۷۳۴۶۶
۵۰۲۲-۲۹۱۰-۷۰۸۷-۳۴۶۶
۵۰۲۲.۲۹۱۰.۷۰۸۷.۳۴۶۶
۵۰۲۲_۲۹۱۰_۷۰۸۷_۳۴۶۶
۵۰۲۲۲۹۱۰۷۰۸۷*۳۴۶۶

constant

Const shebaMapCodes

shebaMapCodes: ShebaMapCodes = ...

Const shebaPattern

shebaPattern: RegExp = ...

since: v1.4.2

Const shebaPatternCode

shebaPatternCode: RegExp = ...

since: v1.4.2

Bank account Functions

extractCardNumber

extractCardNumber(str: string, options?: ExtractCardNumberOptions): ExtractCardNumber[]

- Defined in modules/extractCardNumbers/index.ts:53
Extract Iranian Bank's numbers into a string

Parameters
- str: string
- options: ExtractCardNumberOptions = ...
Returns ExtractCardNumber[]
ExtractCardNumber[]

getBankNameFromCardNumber

getBankNameFromCardNumber(digits?: string | number): string | null | undefined

- Defined in modules/getBankNameFromCardNumber/index.ts:15
Find Bank's name by card number

method
getBankNameFromCardNumber

Parameters
- Optional digits: string | number
  
  Card number
Returns string | null | undefined
string | null | undefined

verifyCardNumber

verifyCardNumber(digits: number): boolean | undefined

- Defined in modules/verifyCardNumber/index.ts:10
description
Verify Iranian Bank's card number which is valid or not

method
verifyCardNumber

Parameters
- digits: number
  
  card number
Returns boolean | undefined

Digits Functions

digitsArToEn

digitsArToEn(value: string): string

- Defined in modules/digits/converters/ar.ts:27
digitsArToEn

description
Takes a string and returns a string that represents the same value but its arabic digits are replaced with english digits

Parameters
- value: string
Returns string

digitsArToFa

digitsArToFa(value: string): string

- Defined in modules/digits/converters/ar.ts:13
digitsArToFa

description
Takes a string and returns a string that represents the same value but its arabic digits are replaced with farsi digits

Parameters
- value: string
Returns string

digitsEnToAr

digitsEnToAr(value: string | number): string

- Defined in modules/digits/converters/en.ts:28
digitsEnToAr

description
Takes a string or number and returns a string that represents the same value but its english digits are replaced with arabic digits

Parameters
- value: string | number
Returns string

digitsEnToFa

digitsEnToFa(value: string | number): string

- Defined in modules/digits/converters/en.ts:13
digitsEnToFa

description
Takes a string or number and returns a string that represents the same value but its english digits are replaced with farsi digits

Parameters
- value: string | number
Returns string

digitsFaToAr

digitsFaToAr(value: string): string

- Defined in modules/digits/converters/fa.ts:27
digitsFaToAr

description
Takes a string and returns a string that represents the same value but its farsi digits are replaced with arabic digits

Parameters
- value: string
Returns string

digitsFaToEn

digitsFaToEn(value: string): string

- Defined in modules/digits/converters/fa.ts:13
digitsFaToEn

description
Takes a string and returns a string that represents the same value but its farsi digits are replaced with english digits

Parameters
- value: string
Returns string

Legal id Functions

verifyIranianLegalId

verifyIranianLegalId(legalId: string | number): boolean | undefined

- Defined in modules/legalId/index.ts:10
Check Legal-id validation

method
verifyIranianLegalId

description
verify Iranian Legal-id(shenase hoghoghi)

link
http://www.aliarash.com/article/shenasameli/shenasa_meli.htm

Parameters
- legalId: string | number
Returns boolean | undefined
[valid or no]

National id Functions

getPlaceByIranNationalId

getPlaceByIranNationalId(nationalId?: string): IPlaceByNationalId | null | undefined

- Defined in modules/getPlaceByIranNationalId/index.ts:32
Get Province and City name by Iranian National-Id

method
getPlaceByIranNationalId

Parameters
- Optional nationalId: string
  
  string of national id - like this: 1111111111
Returns IPlaceByNationalId | null | undefined
If nationalId is valid, function returns an object of details, but if nationalId is invalid, return an error message

verifyIranianNationalId

verifyIranianNationalId(nationalId?: string | number): boolean | undefined

- Defined in modules/nationalId/index.ts:9
Check National-id validation

method
verifyIranianNationalId

Parameters
- Optional nationalId: string | number
Returns boolean | undefined
[valid or no]

Number conversion Functions

wordsToNumber

wordsToNumber<TResult>(words: string, __namedParameters?: WordsToNumberOptions): TResult

- Defined in modules/wordsToNumber/index.ts:67
Convert to numbers

Type Parameters
- TResult extends string | number
Parameters
- words: string
- __namedParameters: WordsToNumberOptions = {}
Returns TResult
Converted words to number. e.g: 350000

Other Functions

Plate

Plate(plate: PlateOptions): PlateResult

- Defined in modules/numberplate/index.ts:22
Get plate info and validation

Parameters
- plate: PlateOptions
  
  An object containing the number and char value or a string.
Returns PlateResult
An object containing plate and validation info.

SortText

SortText<T>(str: T | T[]): T[]

- Defined in modules/sortText/index.ts:13
SortText

description
Takes a piece of text in Persian which contains several lines (separated by the newline character), and sorts the lines alphabetically, with respect to their first character.

deprecated
This function will be removed in the next release and please don't use this function.

Type Parameters
- T extends string
Parameters
- str: T | T[]
  
  a String or a list of strings
Returns T[]

URLfix

URLfix(url?: string, separator?: string): string | undefined

- Defined in modules/URLfix/index.ts:12
method
URLfix

description
Used for fix Persian characters in URL

example
URLfix('https://fa.wikipedia.org/wiki/%D9%85%DA%A9%D8%A7%D9%86%DB%8C%DA%A9%20%DA%A9%D9%88%D8%A7%D9%86%D8%AA%D9%88%D9%85%DB%8C', '_') return 'https://fa.wikipedia.org/wiki/مکانیک_کوانتومی'

Parameters
- Optional url: string
- Optional separator: string
  
  optional argument to replace character with space in URLs. by default return URL with space
Returns string | undefined
a string of fixed URL

addCommas

addCommas(number: string | number): string

- Defined in modules/commas/add.ts:11
Add Commas to numbers

method
addCommas

Parameters
- number: string | number
Returns string
string of separated numbers by commas, eg: 30,000

addOrdinalSuffix

addOrdinalSuffix(number?: string): string

- Defined in modules/addOrdinalSuffix/addOrdinalSuffix.ts:7
Add Ordinal suffix to numbers

method
addOrdinalSuffix

Parameters
- Optional number: string
  
  Number, eg: "300000"
Returns string
A string of ordinated number

findCapitalByProvince

findCapitalByProvince(state: string): string

- Defined in modules/findCapitalByProvince/index.ts:10
Returns the capital name of province you enter

Parameters
- state: string
Returns string
capital name

getShebaInfo

getShebaInfo(shebaCode: string): ShebaResult | null

- Defined in modules/sheba/index.ts:18
since
1.7.1

Parameters
- shebaCode: string
Returns ShebaResult | null

halfSpace

halfSpace(str: string): string

- Defined in modules/halfSpace/index.ts:8
Replace halfSpace in string(Zero-width non-joiner)

method
halfSpace

Parameters
- str: string
Returns string
clean entered persian string

hasArabic

hasArabic(str: string): boolean

- Defined in modules/isArabic/index.ts:22
Check if string includes Arabic alphabet.

Parameters
- str: string
Returns boolean
Return true if the entered string includes persian characters

hasPersian

hasPersian(str: string, isComplex?: boolean): boolean

- Defined in modules/isPersian/index.ts:25
Check if string includes persian alphabet.

Parameters
- str: string
- isComplex: boolean = false
  
  in complex mode, we accept some specific characters which are common in Farsi text.
Returns boolean
Return true if the entered string includes persian characters

isArabic

isArabic(str: string, trimPattern?: RegExp): boolean

- Defined in modules/isArabic/index.ts:10
Check if string is Arabic

Parameters
- str: string
- trimPattern: RegExp = ...
  
  Pattern of characters which you want to trim from the string e.g. "-+. ()"
Returns boolean
Return true if the entered string does not include other-language characters.

isPersian

isPersian(str: string, isComplex?: boolean, trimPattern?: RegExp): boolean

- Defined in modules/isPersian/index.ts:11
Check if string is in persian.

Parameters
- str: string
- isComplex: boolean = false
  
  in complex mode, we accept some specific characters which are common in Farsi text.
- trimPattern: RegExp = ...
  
  Pattern of characters which you want to trim from the string e.g. "-+. ()"
Returns boolean
Return true if the entered string does not include other-language characters.

isShebaValid

isShebaValid(shebaCode: string): boolean

- Defined in modules/sheba/index.ts:62
since
1.7.1

Parameters
- shebaCode: string
Returns boolean

numberToWords

numberToWords(numberValue: string | number, options?: NumberToWordsOptions): string | TypeError

- Defined in modules/numberToWords/index.ts:11
Parameters
- numberValue: string | number
- Optional options: NumberToWordsOptions
Returns string | TypeError

remainingTime

remainingTime(date: string | number | Date): RemainingTime & ToString & IsFinished

- Defined in modules/remainingTime/index.ts:33
Parameters
- date: string | number | Date
Returns RemainingTime & ToString & IsFinished

removeCommas

removeCommas(str: string): number

- Defined in modules/commas/remove.ts:7
Remove all commas in string

Parameters
- str: string
Returns number
A number which includes any commas

removeOrdinalSuffix

removeOrdinalSuffix(word: string): undefined | string

- Defined in modules/removeOrdinalSuffix/index.ts:10
description
Remove Ordinal suffix in words

function
removeOrdinalSuffix

example
removeOrdinalSuffix("سه هزارم") // سه هزار removeOrdinalSuffix("سه هزارمین") // سه هزار

Parameters
- word: string
  
  String that includes ordinal suffix
Returns undefined | string
A string of words that not includes Ordinal strings

Private shebaIso7064Mod97

shebaIso7064Mod97(iban: string): number

- Defined in modules/sheba/index.ts:46
since
1.7.1

Parameters
- iban: string
Returns number

toPersianChars

toPersianChars(str: string): string | undefined

- Defined in modules/toPersianChars/index.ts:12
toPersianChars

Description: Replace all instances of ي and ك with ی and ک, respectively. It should not make any changes to an Arabic text surrounded by appropriate templates.

method
toPersianChars

Parameters
- str: string
Returns string | undefined
cleaned characters of arabic characters

Phone number Functions

phoneNumberDetail

phoneNumberDetail(mobile: string): OperatorModel | null

- Defined in modules/phoneNumber/detail.ts:19
Find information such as Province, type and model of mobile number. This function is related to the phoneNumberValidator function to detect that the mobile number is valid or not If the Mobile number was valid, then the OperatorModel will be resolved if it was existed. To get more information about phone numbers operators' details, referer to Wikipedia

example
phoneNumberDetail("9123456789")

Parameters
- mobile: string
Returns OperatorModel | null
OperatorModel | null

phoneNumberNormalizer

phoneNumberNormalizer(phoneNumber: string, token: "0" | "+98"): string

- Defined in modules/phoneNumber/normalizer.ts:20
Normalize a phone number to a standard format based on the provided token. This function is related to the phoneNumberValidator function to detect that the mobile number is valid or not

example
phoneNumberNormalizer("+989022002580", "0"); // 09022002580 phoneNumberNormalizer("989022002580", "0"); // 09022002580 phoneNumberNormalizer("09022002580", "0"); // 09022002580 phoneNumberNormalizer("09022002580", "+98"); //+989022002580 phoneNumberNormalizer("09802002580", "0"); // Error : this is not valid phone number

Parameters
- phoneNumber: string
- token: "0" | "+98"
  
  can be either +98 or 0
Returns string
String | never

phoneNumberValidator

phoneNumberValidator(mobile: string): boolean

- Defined in modules/phoneNumber/validator.ts:7
Parameters
- mobile: string
Returns boolean

timeAgo Functions

timeAgo

timeAgo(datetime?: string): string

- Defined in modules/timeAgo/index.ts:63
Converting Jalali date-time into a time ago.

Parameters
- datetime: string = ""
  
  Format must be yyyy/mm/dd hh:mm:ss. If no value is entered for input, the current time is considered.
Returns string
Return time ago value. Eg: حدود 1 سال قبل

Index

Enumerations Plate

Classes

Interfaces Bank account

Interfaces National id

Interfaces Number conversion

Interfaces Other

Interfaces Phone number

Interfaces Plate

Type Aliases Other

Type Aliases Plate

Variables

Functions Bank account

Functions Digits

Functions Legal id

Functions National id

Functions Number conversion

Functions Other

Functions Phone number

Functions timeAgo

Other Type Aliases

DigitsConverter

Type Parameters

I = string

O = string

Type declaration

Parameters

value: I

Returns O

ShebaMapCodes

Plate Type Aliases

PlateOptions

PlateResultApiTypeString

Variables

Const acceptableKeywords

Const cardNumberRegex

Const shebaMapCodes

Const shebaPattern

Const shebaPatternCode

Bank account Functions

extractCardNumber

Parameters

str: string

options: ExtractCardNumberOptions = ...

Returns ExtractCardNumber[]

getBankNameFromCardNumber

Parameters

Optional digits: string | number

Returns string | null | undefined

verifyCardNumber

Parameters

digits: number

Returns boolean | undefined

Digits Functions

digitsArToEn

Parameters

value: string

Returns string

digitsArToFa

Parameters

value: string

Returns string

digitsEnToAr

Parameters

value: string | number

Returns string

digitsEnToFa

Parameters

value: string | number

Returns string

digitsFaToAr

Parameters

value: string

Returns string

digitsFaToEn

Parameters

value: string

Returns string

Legal id Functions

verifyIranianLegalId