Interface MwString

Type definitions for the methods of mw.String.

Note that the relevant object is not part of WpLibExtra (the interface is available in the npm package).

Hierarchy

MwString

Index

Methods

byteLength charAt codePointLength lcFirst trimByteLength trimCodePointLength ucFirst

Methods

byteLength

byteLength(str): number
Calculate the byte length of a string (accounting for UTF-8).
Parameters
- str: string
Returns number
- Defined in wp-lib-extra.ts:46

charAt

charAt(string, offset, backwards?): string
Like String#charAt, but return the pair of UTF-16 surrogates for characters outside of BMP.
Parameters
- string: string
- offset: number
  
  Offset to extract the character.
- Optional backwards: boolean
  
  Use backwards direction to detect UTF-16 surrogates, defaults to false.
Returns string
- Defined in wp-lib-extra.ts:60

codePointLength

codePointLength(str): number
Calculate the character length of a string (accounting for UTF-16 surrogates).
Parameters
- str: string
Returns number
- Defined in wp-lib-extra.ts:52

lcFirst

lcFirst(string): string
Lowercase the first character. Support UTF-16 surrogates for characters outside of BMP.
Parameters
- string: string
Returns string
- Defined in wp-lib-extra.ts:66

trimByteLength

trimByteLength(safeVal, newVal, byteLimit, filterFunction?): {
newVal: string;
trimmed: boolean;
}
Utility function to trim down a string, based on byteLimit and given a safe start position. It supports insertion anywhere in the string, so "foo" to "fobaro" if limit is 4 will result in "fobo", not "foba". Basically emulating the native maxlength by reconstructing where the insertion occurred.
Parameters
- safeVal: string
  
  Known value that was previously returned by this function, if none, pass empty string.
- newVal: string
  
  New value that may have to be trimmed down.
- byteLimit: number
  
  Number of bytes the value may be in size.
- Optional filterFunction: ((val) => number)
  
  Function to call on the string before assessing the length.
  - - (val): number
    - Parameters
      
      val: string
      
      Returns number
Returns {
newVal: string;
trimmed: boolean;
}
- newVal: string
- trimmed: boolean
- Defined in wp-lib-extra.ts:84

trimCodePointLength

trimCodePointLength(safeVal, newVal, codePointLimit, filterFunction?): {
newVal: string;
trimmed: boolean;
}
Utility function to trim down a string, based on codePointLimit and given a safe start position. It supports insertion anywhere in the string, so "foo" to "fobaro" if limit is 4 will result in "fobo", not "foba". Basically emulating the native maxlength by reconstructing where the insertion occurred.
Parameters
- safeVal: string
  
  Known value that was previously returned by this function, if none, pass empty string.
- newVal: string
  
  New value that may have to be trimmed down.
- codePointLimit: number
  
  Number of characters the value may be in size.
- Optional filterFunction: ((val) => number)
  
  Function to call on the string before assessing the length.
  - - (val): number
    - Parameters
      
      val: string
      
      Returns number
Returns {
newVal: string;
trimmed: boolean;
}
- newVal: string
- trimmed: boolean
- Defined in wp-lib-extra.ts:96

ucFirst

ucFirst(string): string
Uppercase the first character. Support UTF-16 surrogates for characters outside of BMP.
Parameters
- string: string
Returns string
- Defined in wp-lib-extra.ts:72

Interface MwString

Hierarchy

Index

Methods

Methods

byteLength

Parameters

str: string

Returns number

charAt

Parameters

string: string

offset: number

Optional backwards: boolean

Returns string

codePointLength

Parameters

str: string

Returns number

lcFirst

Parameters

string: string

Returns string

trimByteLength

Parameters

safeVal: string

newVal: string

byteLimit: number

Optional filterFunction: ((val) => number)

Parameters

val: string

Returns number

Returns { newVal: string; trimmed: boolean; }

newVal: string

trimmed: boolean

trimCodePointLength

Parameters

safeVal: string

newVal: string

codePointLimit: number

Optional filterFunction: ((val) => number)

Parameters

val: string

Returns number

Returns { newVal: string; trimmed: boolean; }

newVal: string

trimmed: boolean

ucFirst

Parameters

string: string

Returns string

Settings

Member Visibility

Theme

On This Page

`Optional` backwards: boolean

`Optional` filterFunction: ((val) => number)

Returns {
newVal: string;
trimmed: boolean;
}

`Optional` filterFunction: ((val) => number)

Returns {
newVal: string;
trimmed: boolean;
}