Skip to content

pandasx / MergeOptions

Interface: MergeOptions ​

Defined in: src/reshape.ts:78

Properties ​

PropertyTypeDescriptionDefined in
how?"left" | "right" | "inner" | "outer" | "cross"Join type (default 'inner').src/reshape.ts:80
indicator?booleanAdds a _merge column: 'left_only''right_only'
leftIndex?booleanUse the left / right index (all levels) as join key(s).src/reshape.ts:94
leftOn?string | readonly string[]-src/reshape.ts:83
on?string | readonly string[]Key column(s) present in both frames (defaults to the shared columns).src/reshape.ts:82
rightIndex?boolean-src/reshape.ts:95
rightOn?string | readonly string[]-src/reshape.ts:84
sort?booleanSort the result by the join keys.src/reshape.ts:90
suffixes?readonly [string, string]Suffixes for overlapping non-key columns (default ['_x', '_y']).src/reshape.ts:86
validate?"1:1" | "1:m" | "m:1" | "m:m"Check the key relationship, e.g. '1:1', '1:m', 'm:1'.src/reshape.ts:92

Released under the MIT License.