df-script 1.8.0 → 2.0.0

package/dist/columnExpressions/mixins/LogicalExpr.d.ts

@@ -10,11 +10,18 @@ export declare class LogicalExpr extends ExprBase {
      * @param other The other boolean column expression or literal value to compare.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({
-     * ...   a: [true, true, false, null],
-     * ...   b: [true, false, false, true]
-     * ... })
-     * >>> df.with_columns($df.col("a").and($df.col("b")).alias("and_res"))
+ * >>> const df = $df.data({ a: [true, true, false, false], b: [true, false, true, false] })
+ * >>> df
+ * shape: (4, 2)
+ * ┌───────┬───────┐
+ * │ a     │ b     │
+ * ├───────┼───────┤
+ * │ true  │ true  │
+ * │ true  │ false │
+ * │ false │ true  │
+ * │ false │ false │
+ * └───────┴───────┘
+     * >>> df.withColumns($df.col("a").and($df.col("b")).alias("and_res"))
      * shape: (4, 3)
      * ┌───────┬───────┬─────────┐
      * │ a     │ b     │ and_res │
@@ -30,18 +37,27 @@ export declare class LogicalExpr extends ExprBase {
      * Logical negation.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({
-     * ...   is_active: [true, false, null]
-     * ... })
-     * >>> df.with_columns($df.col("is_active").not().alias("is_inactive"))
-     * shape: (3, 2)
-     * ┌───────────┬─────────────┐
-     * │ is_active │ is_inactive │
-     * ├───────────┼─────────────┤
-     * │ true      │ false       │
-     * │ false     │ true        │
-     * │ null      │ null        │
-     * └───────────┴─────────────┘
+ * >>> const df = $df.data({ a: [true, true, false, false], b: [true, false, true, false] })
+ * >>> df
+ * shape: (4, 2)
+ * ┌───────┬───────┐
+ * │ a     │ b     │
+ * ├───────┼───────┤
+ * │ true  │ true  │
+ * │ true  │ false │
+ * │ false │ true  │
+ * │ false │ false │
+ * └───────┴───────┘
+     * >>> df.withColumns($df.col("a").not().alias("not_a"))
+     * shape: (4, 3)
+     * ┌───────┬───────┬───────┐
+     * │ a     │ b     │ not_a │
+     * ├───────┼───────┼───────┤
+     * │ true  │ true  │ false │
+     * │ true  │ false │ false │
+     * │ false │ false │ true  │
+     * │ null  │ true  │ null  │
+     * └───────┴───────┴───────┘
      */
     not(): this;
     /**
@@ -49,19 +65,26 @@ export declare class LogicalExpr extends ExprBase {
      * @param other The other boolean column expression or literal value to compare.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({
-     * ...   a: [true, false, false, null],
-     * ...   b: [false, false, true, false]
-     * ... })
-     * >>> df.with_columns($df.col("a").or($df.col("b")).alias("or_res"))
+ * >>> const df = $df.data({ a: [true, true, false, false], b: [true, false, true, false] })
+ * >>> df
+ * shape: (4, 2)
+ * ┌───────┬───────┐
+ * │ a     │ b     │
+ * ├───────┼───────┤
+ * │ true  │ true  │
+ * │ true  │ false │
+ * │ false │ true  │
+ * │ false │ false │
+ * └───────┴───────┘
+     * >>> df.withColumns($df.col("a").or($df.col("b")).alias("or_res"))
      * shape: (4, 3)
      * ┌───────┬───────┬────────┐
      * │ a     │ b     │ or_res │
      * ├───────┼───────┼────────┤
+     * │ true  │ true  │ true   │
      * │ true  │ false │ true   │
      * │ false │ false │ false  │
-     * │ false │ true  │ true   │
-     * │ null  │ false │ null   │
+     * │ null  │ true  │ true   │
      * └───────┴───────┴────────┘
      */
     or(other: any): this;
@@ -70,11 +93,18 @@ export declare class LogicalExpr extends ExprBase {
      * @param other The other boolean column expression or literal value to compare.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({
-     * ...   a: [true, true, false, false],
-     * ...   b: [true, false, true, false]
-     * ... })
-     * >>> df.with_columns($df.col("a").xor($df.col("b")).alias("xor_res"))
+ * >>> const df = $df.data({ a: [true, true, false, false], b: [true, false, true, false] })
+ * >>> df
+ * shape: (4, 2)
+ * ┌───────┬───────┐
+ * │ a     │ b     │
+ * ├───────┼───────┤
+ * │ true  │ true  │
+ * │ true  │ false │
+ * │ false │ true  │
+ * │ false │ false │
+ * └───────┴───────┘
+     * >>> df.withColumns($df.col("a").xor($df.col("b")).alias("xor_res"))
      * shape: (4, 3)
      * ┌───────┬───────┬─────────┐
      * │ a     │ b     │ xor_res │

package/dist/columnExpressions/mixins/ManipulationExpr.d.ts

@@ -11,10 +11,17 @@ export declare class ManipulationExpr extends ExprBase {
      * @param options Configuration options including fill value, strategy ("forward", "backward", "zero", "one", "mean", "min", "max"), and optional limit.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({
-     * ...   a: [1, null, 3]
-     * ... })
-     * >>> df.with_columns($df.col("a").fill_null({ value: 0 }).alias("filled"))
+ * >>> const df = $df.data({ a: [1, null, 3], b: [null, 2, null] })
+ * >>> df
+ * shape: (3, 2)
+ * ┌──────┬──────┐
+ * │ a    │ b    │
+ * ├──────┼──────┤
+ * │ 1    │ null │
+ * │ null │ 2    │
+ * │ 3    │ null │
+ * └──────┴──────┘
+     * >>> df.withColumns($df.col("a").fillNull({ value: 0 }).alias("filled"))
      * shape: (3, 2)
      * ┌──────┬────────┐
      * │ a    │ filled │
@@ -24,15 +31,22 @@ export declare class ManipulationExpr extends ExprBase {
      * │ 3    │ 3      │
      * └──────┴────────┘
      */
-    fill_null({ value, strategy, limit }?: FillNullOptions): this;
+    fillNull({ value, strategy, limit }?: FillNullOptions): this;
     /**
      * Reverses the order of values in the column.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({
-     * ...   a: [1, 2, 3]
-     * ... })
-     * >>> df.with_columns($df.col("a").reverse().alias("reversed"))
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").reverse().alias("reversed"))
      * shape: (3, 2)
      * ┌───┬──────────┐
      * │ a │ reversed │