pandasx / StringMethods

Class: StringMethods

Defined in: src/accessors.ts:13

Vectorised string functions (series.str). Missing values stay missing.

Constructors

Constructor

new StringMethods(s): StringMethods

Defined in: src/accessors.ts:16

Parameters

Parameter	Type
s	Series

Returns

StringMethods

Methods

capitalize()

capitalize(): Series

Defined in: src/accessors.ts:53

Returns

Series

---

casefold()

casefold(): Series

Defined in: src/accessors.ts:52

Returns

Series

---

cat()

Call Signature

cat(): string

Defined in: src/accessors.ts:301

Concatenates all values (others omitted) or element-wise with other Series/arrays.

Returns

string

Call Signature

cat(options): string

Defined in: src/accessors.ts:302

Concatenates all values (others omitted) or element-wise with other Series/arrays.

Parameters

Parameter	Type
options	{ naRep?: string; sep?: string; }
options.naRep?	string
options.sep?	string

Returns

string

Call Signature

cat(others, options?): Series

Defined in: src/accessors.ts:303

Concatenates all values (others omitted) or element-wise with other Series/arrays.

Parameters

Parameter	Type
others	readonly unknown[] | Series | readonly (readonly unknown[] | Series)[]
options?	{ naRep?: string; sep?: string; }
options.naRep?	string
options.sep?	string

Returns

Series

---

center()

center(width, fillchar?): Series

Defined in: src/accessors.ts:77

Parameters

Parameter	Type	Default value
width	number	undefined
fillchar	string	' '

Returns

Series

---

contains()

contains(pat, options?): Series

Defined in: src/accessors.ts:106

Regex test like pandas (regex: false for a plain substring); na fills missing values.

Parameters

Parameter	Type
pat	string | RegExp
options	{ case?: boolean; flags?: string; na?: unknown; regex?: boolean; }
options.case?	boolean
options.flags?	string
options.na?	unknown
options.regex?	boolean

Returns

Series

---

count()

count(pat): Series

Defined in: src/accessors.ts:146

Parameters

Parameter	Type
pat	string | RegExp

Returns

Series

---

decode()

decode(encoding?): Series

Defined in: src/accessors.ts:335

Decodes Buffers / Uint8Arrays to strings.

Parameters

Parameter	Type	Default value
encoding	BufferEncoding	'utf8'

Returns

Series

---

encode()

encode(encoding?): Series

Defined in: src/accessors.ts:331

Encodes strings to Buffers.

Parameters

Parameter	Type	Default value
encoding	BufferEncoding	'utf8'

Returns

Series

---

endswith()

endswith(suffix, options?): Series

Defined in: src/accessors.ts:131

Parameters

Parameter	Type
suffix	string | readonly string[]
options	{ na?: unknown; }
options.na?	unknown

Returns

Series

---

extract()

Call Signature

extract(pat, options?): DataFrame

Defined in: src/accessors.ts:173

Capture groups of the first match. With expand (default) returns a DataFrame (named groups become column names); with one group and expand: false a Series.

Parameters

Parameter	Type
pat	string | RegExp
options?	{ expand?: true; }
options.expand?	true

Returns

DataFrame

Call Signature

extract(pat, options): Series

Defined in: src/accessors.ts:174

Capture groups of the first match. With expand (default) returns a DataFrame (named groups become column names); with one group and expand: false a Series.

Parameters

Parameter	Type
pat	string | RegExp
options	{ expand: false; }
options.expand	false

Returns

Series

---

extractall()

extractall(pat): DataFrame

Defined in: src/accessors.ts:187

Every match's groups, one row per match, indexed by (original label, match number).

Parameters

Parameter	Type
pat	string | RegExp

Returns

DataFrame

---

find()

find(sub, start?, end?): Series

Defined in: src/accessors.ts:150

Parameters

Parameter	Type	Default value
sub	string	undefined
start	number	0
end?	number	undefined

Returns

Series

---

findall()

findall(pat): Series

Defined in: src/accessors.ts:164

All matches of pat per element (arrays).

Parameters

Parameter	Type
pat	string | RegExp

Returns

Series

---

fullmatch()

fullmatch(pat, options?): Series

Defined in: src/accessors.ts:122

Regex matching the whole string.

Parameters

Parameter	Type
pat	string | RegExp
options	{ case?: boolean; na?: unknown; }
options.case?	boolean
options.na?	unknown

Returns

Series

---

get()

get(i): Series

Defined in: src/accessors.ts:288

Element i of each array/string (e.g. after split).

Parameters

Parameter	Type
i	number

Returns

Series

---

getDummies()

getDummies(sep?): DataFrame

Defined in: src/accessors.ts:322

One indicator column per distinct value of sep-separated tokens.

Parameters

Parameter	Type	Default value
sep	string	'|'

Returns

DataFrame

---

index()

index(sub, start?, end?): Series

Defined in: src/accessors.ts:157

Like find but throws when not found.

Parameters

Parameter	Type	Default value
sub	string	undefined
start	number	0
end?	number	undefined

Returns

Series

---

isalnum()

isalnum(): Series

Defined in: src/accessors.ts:135

Returns

Series

---

isalpha()

isalpha(): Series

Defined in: src/accessors.ts:136

Returns

Series

---

isdecimal()

isdecimal(): Series

Defined in: src/accessors.ts:137

Returns

Series

---

isdigit()

isdigit(): Series

Defined in: src/accessors.ts:138

Returns

Series

---

islower()

islower(): Series

Defined in: src/accessors.ts:141

Returns

Series

---

isnumeric()

isnumeric(): Series

Defined in: src/accessors.ts:139

Returns

Series

---

isspace()

isspace(): Series

Defined in: src/accessors.ts:140

Returns

Series

---

istitle()

istitle(): Series

Defined in: src/accessors.ts:143

Returns

Series

---

isupper()

isupper(): Series

Defined in: src/accessors.ts:142

Returns

Series

---

join()

join(sep): Series

Defined in: src/accessors.ts:297

Joins array elements (e.g. after split) with sep.

Parameters

Parameter	Type
sep	string

Returns

Series

---

len()

len(): Series

Defined in: src/accessors.ts:103

Returns

Series

---

ljust()

ljust(width, fillchar?): Series

Defined in: src/accessors.ts:78

Parameters

Parameter	Type	Default value
width	number	undefined
fillchar	string	' '

Returns

Series

---

lower()

lower(): Series

Defined in: src/accessors.ts:50

Returns

Series

---

lstrip()

lstrip(chars?): Series

Defined in: src/accessors.ts:62

Parameters

Parameter	Type
chars?	string

Returns

Series

---

match()

match(pat, options?): Series

Defined in: src/accessors.ts:117

Regex anchored at the start.

Parameters

Parameter	Type
pat	string | RegExp
options	{ case?: boolean; na?: unknown; }
options.case?	boolean
options.na?	unknown

Returns

Series

---

normalize()

normalize(form): Series

Defined in: src/accessors.ts:58

Unicode normalisation form: 'NFC', 'NFKC', 'NFD' or 'NFKD'.

Parameters

Parameter	Type
form	"NFC" | "NFKC" | "NFD" | "NFKD"

Returns

Series

---

pad()

pad(width, side?, fillchar?): Series

Defined in: src/accessors.ts:67

Parameters

Parameter	Type	Default value
width	number	undefined
side	"both" | "left" | "right"	'left'
fillchar	string	' '

Returns

Series

---

partition()

partition(sep?, options?): DataFrame | Series

Defined in: src/accessors.ts:279

Splits at the first sep into [before, sep, after].

Parameters

Parameter	Type	Default value
sep	string	' '
options	{ expand?: boolean; }	{}
options.expand?	boolean	undefined

Returns

DataFrame | Series

---

removeprefix()

removeprefix(prefix): Series

Defined in: src/accessors.ts:64

Parameters

Parameter	Type
prefix	string

Returns

Series

---

removesuffix()

removesuffix(suffix): Series

Defined in: src/accessors.ts:65

Parameters

Parameter	Type
suffix	string

Returns

Series

---

repeat()

repeat(n): Series

Defined in: src/accessors.ts:247

Parameters

Parameter	Type
n	number

Returns

Series

---

replace()

replace(pat, repl, options?): Series

Defined in: src/accessors.ts:206

Replaces occurrences; regex defaults to true for RegExp patterns. n limits replacements.

Parameters

Parameter	Type
pat	string | RegExp
repl	string | ((match, ...groups) => string)
options	{ case?: boolean; n?: number; regex?: boolean; }
options.case?	boolean
options.n?	number
options.regex?	boolean

Returns

Series

---

rfind()

rfind(sub, start?, end?): Series

Defined in: src/accessors.ts:153

Parameters

Parameter	Type	Default value
sub	string	undefined
start	number	0
end?	number	undefined

Returns

Series

---

rindex()

rindex(sub, start?, end?): Series

Defined in: src/accessors.ts:160

Parameters

Parameter	Type	Default value
sub	string	undefined
start	number	0
end?	number	undefined

Returns

Series

---

rjust()

rjust(width, fillchar?): Series

Defined in: src/accessors.ts:79

Parameters

Parameter	Type	Default value
width	number	undefined
fillchar	string	' '

Returns

Series

---

rpartition()

rpartition(sep?, options?): DataFrame | Series

Defined in: src/accessors.ts:283

Parameters

Parameter	Type	Default value
sep	string	' '
options	{ expand?: boolean; }	{}
options.expand?	boolean	undefined

Returns

DataFrame | Series

---

rsplit()

Call Signature

rsplit(pat?, options?): Series

Defined in: src/accessors.ts:266

Splits from the right.

Parameters

Parameter	Type
pat?	string
options?	{ expand?: false; n?: number; }
options.expand?	false
options.n?	number

Returns

Series

Call Signature

rsplit(pat, options): DataFrame

Defined in: src/accessors.ts:267

Splits from the right.

Parameters

Parameter	Type
pat	string | undefined
options	{ expand: true; n?: number; }
options.expand	true
options.n?	number

Returns

DataFrame

---

rstrip()

rstrip(chars?): Series

Defined in: src/accessors.ts:63

Parameters

Parameter	Type
chars?	string

Returns

Series

---

slice()

slice(start?, stop?, step?): Series

Defined in: src/accessors.ts:236

Parameters

Parameter	Type	Default value
start?	number	undefined
stop?	number	undefined
step?	number	1

Returns

Series

---

sliceReplace()

sliceReplace(start?, stop?, repl?): Series

Defined in: src/accessors.ts:244

Parameters

Parameter	Type	Default value
start?	number	undefined
stop?	number	undefined
repl?	string	''

Returns

Series

---

split()

Call Signature

split(pat?, options?): Series

Defined in: src/accessors.ts:258

Splits each string (whitespace by default). With expand returns a DataFrame with one column per part; n limits the number of splits.

Parameters

Parameter	Type
pat?	string | RegExp
options?	{ expand?: false; n?: number; regex?: boolean; }
options.expand?	false
options.n?	number
options.regex?	boolean

Returns

Series

Call Signature

split(pat, options): DataFrame

Defined in: src/accessors.ts:259

Splits each string (whitespace by default). With expand returns a DataFrame with one column per part; n limits the number of splits.

Parameters

Parameter	Type
pat	string | RegExp | undefined
options	{ expand: true; n?: number; regex?: boolean; }
options.expand	true
options.n?	number
options.regex?	boolean

Returns

DataFrame

---

startswith()

startswith(prefix, options?): Series

Defined in: src/accessors.ts:127

Parameters

Parameter	Type
prefix	string | readonly string[]
options	{ na?: unknown; }
options.na?	unknown

Returns

Series

---

strip()

strip(chars?): Series

Defined in: src/accessors.ts:61

Parameters

Parameter	Type
chars?	string

Returns

Series

---

swapcase()

swapcase(): Series

Defined in: src/accessors.ts:56

Returns

Series

---

title()

title(): Series

Defined in: src/accessors.ts:55

Python str.title: a letter is capitalised after any non-letter.

Returns

Series

---

translate()

translate(table): Series

Defined in: src/accessors.ts:249

Maps characters through a table {char: replacement | null}.

Parameters

Parameter	Type
table	Record<string, string | null>

Returns

Series

---

upper()

upper(): Series

Defined in: src/accessors.ts:51

Returns

Series

---

wrap()

wrap(width): Series

Defined in: src/accessors.ts:87

Wraps long strings at width characters, joining lines with '\n'.

Parameters

Parameter	Type
width	number

Returns

Series

---

zfill()

zfill(width): Series

Defined in: src/accessors.ts:80

Parameters

Parameter	Type
width	number

Returns

Series