Add do notation for Array

[KhraksMamtsov]

Type

• Refactor
• Feature
• Bug Fix
• Optimization
• Documentation Update

Description

Do notation (pipe version) for Array module.

Related

• Related Issue #
• Closes #

[changeset-bot]

🦋 Changeset detected

Latest commit: 0f50aa2

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 24 packages

Name	Type
effect	Minor
@effect/cli	Major
@effect/experimental	Major
@effect/opentelemetry	Major
@effect/platform-browser	Major
@effect/platform-bun	Major
@effect/platform-node-shared	Major
@effect/platform-node	Major
@effect/platform	Major
@effect/printer-ansi	Major
@effect/printer	Major
@effect/rpc-http	Major
@effect/rpc	Major
@effect/schema	Major
@effect/sql-mssql	Major
@effect/sql-mysql2	Major
@effect/sql-pg	Major
@effect/sql-sqlite-bun	Major
@effect/sql-sqlite-node	Major
@effect/sql-sqlite-react-native	Major
@effect/sql-sqlite-wasm	Major
@effect/sql	Major
@effect/typeclass	Major
@effect/vitest	Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[datner]

This looks fine, but I must know:
why? What can this be used for? 🤔

Also please add more jsdocs, preferably with example 🙏🏻

[mikearnaldi]

This looks fine, but I must know: why? What can this be used for? 🤔

Also please add more jsdocs, preferably with example 🙏🏻

Do in array is as important as do in stream it's used to build up on products basically (zipWith on steroids)

[KhraksMamtsov]

This looks fine, but I must know: why? What can this be used for? 🤔

Also please add more jsdocs, preferably with example 🙏🏻

I use this to generate independent props for stories in storybook

const btnProps = pipe(
    RA.Do,
    RA.bind("size", () => ["small", "medium", "large"] as const),
    RA.bind("theme", () => ["dark", "light", "contrast-light", "contrast-dark"] as const),
    RA.bind("disabled", () => [false, true]),
    RA.bind("loading", () => [false, true]),
    RA.bind("leftIcon", () => [null, "arrow-left", "disk"]),
    RA.bind("rightIcon", () => [null, "arrow-right", "save"]),
    RA.bind("text", () => [lorem(1), lorem(3), lorem(10)])
)

[gcanti]

can be used to simulate "array comprehension"

Array comprehension is a technique in programming that allows you to create new arrays by iterating over existing ones and applying specific conditions or transformations to the elements. It's like assembling a new collection from pieces of other collections based on certain rules.

Haskell

[(x,y) | x <- [1,3,5], y <- [2,4,6], x < y]
-- Output: [(1,2),(1,4),(1,6),(3,4),(3,6),(5,6)]

Effect

import { Array as Arr, pipe } from "effect"

const result = pipe(
  Arr.Do,
  Arr.bind("x", () => [1, 3, 5]),
  Arr.bind("y", () => [2, 4, 6]),
  Arr.filter(({ x, y }) => x < y), // condition
  Arr.map(({ x, y }) => [x, y] as const) // transformation
)

console.log(result)
/*
Output:
[ [ 1, 2 ], [ 1, 4 ], [ 1, 6 ], [ 3, 4 ], [ 3, 6 ], [ 5, 6 ] ]
*/

We could use this short explanation / example (without the Haskell bit) in the docs

@KhraksMamtsov I've merged this PR that makes it easier to define the do notation for Array #2681

[KhraksMamtsov]

@gcanti If you don't mind, I'll add

// doNotation.ts
export type EmptyScope<F extends TypeLambda> = Kind<F, never, never, never, {}>
// module
export const Do: doNotation.EmptyScope<ModuleTypeLambda> = ...

[gcanti]

I think our convention is not to export anything public from the internal folder

[datner]

Do in array is as important as do in stream it's used to build up on products basically (zipWith on steroids)

I conceptualize this well 🤔

but the size doesn't explode?

const btnProps = pipe(
    RA.Do,
    RA.bind("size", () => ["small", "medium", "large"] as const),
    RA.bind("theme", () => ["dark", "light", "contrast-light", "contrast-dark"] as const),
    RA.bind("disabled", () => [false, true]),
    RA.bind("loading", () => [false, true]),
    RA.bind("leftIcon", () => [null, "arrow-left", "disk"]),
    RA.bind("rightIcon", () => [null, "arrow-right", "save"]),
    RA.bind("text", () => [lorem(1), lorem(3), lorem(10)])
)

thats an array of 1,296 members, no?

This is not to say not to add this, I'm purely interested in the concept and utility