Path

The effect/Path module provides a set of operations for working with file paths.

Basic Usage

The module provides a single Path service key, which acts as the gateway for interacting with paths.

Example (Accessing the Path Service)

1
import { Effect, Path } from "effect"
2

3
const program = Effect.gen(function* () {
4
  const path = yield* Path.Path
5

6
  // Use `path` to perform various path operations
7
})
8

9
Path.Path.key // => "effect/Path"

The Path interface includes the following operations:

Operation	Description
basename	Returns the last part of a path, optionally removing a given suffix.
dirname	Returns the directory part of a path.
extname	Returns the file extension from a path.
format	Formats a path object into a path string.
fromFileUrl	Converts a file URL to a path.
isAbsolute	Checks if a path is absolute.
join	Joins multiple path segments into one.
normalize	Normalizes a path by resolving `.` and `..` segments.
parse	Parses a path string into an object with its segments.
relative	Computes the relative path from one path to another.
resolve	Resolves a sequence of paths to an absolute path.
sep	Returns the platform-specific path segment separator (e.g., `/` on POSIX).
toFileUrl	Converts a path to a file URL.
toNamespacedPath	Converts a path to a namespaced path (specific to Windows).

Example (Joining Path Segments)

1
import { Effect, Path } from "effect"
2
import { NodeServices, NodeRuntime } from "@effect/platform-node"
3

4
const program = Effect.gen(function* () {
5
  const path = yield* Path.Path
6

7
  const mypath = path.join("tmp", "file.txt")
8
  console.log(mypath)
9
})
10

11
NodeRuntime.runMain(program.pipe(Effect.provide(NodeServices.layer)))
12
// Output: "tmp/file.txt"