effect-path

path

Use effect Path abstraction for platform-abstract file path operations. Apply this skill when working with file paths, joining segments, resolving absolute paths, or converting between file URLs and paths. Path.layer supplies POSIX semantics from effect; Node.js and Bun platform layers provide host-specific path semantics. @effect/platform-browser does not provide a BrowserPath layer in beta.74, so browser code should provide Path.layer or a custom layer explicitly.

Import Pattern

import { Path } from 'effect';

Service Injection

import { Path } from 'effect';
import { Effect } from 'effect';

const program = Effect.gen(function* () {
	const path = yield* Path.Path;
});

Path Separator

import { Path } from 'effect';
import { Effect } from 'effect';

// Get platform-specific separator
const program = Effect.gen(function* () {
	const path = yield* Path.Path;
	const separator = path.sep; // "/" on Unix, "\" on Windows
});

Path Operations

join - Combine path segments

import { Path } from 'effect';
import { Effect } from 'effect';

const program = Effect.gen(function* () {
	const path = yield* Path.Path;
	const fullPath = path.join('src', 'components', 'Button.tsx');
	// "src/components/Button.tsx" on Unix
	// "src\components\Button.tsx" on Windows
});

resolve - Convert to absolute path

import { Path } from 'effect';
import { Effect } from 'effect';

const program = Effect.gen(function* () {
	const path = yield* Path.Path;
	const absolutePath = path.resolve('src', 'index.ts');
	// "/Users/username/project/src/index.ts" on Unix
	// "C:\Users\username\project\src\index.ts" on Windows
});

normalize - Clean up path

import { Path } from 'effect';
import { Effect } from 'effect';

const program = Effect.gen(function* () {
	const path = yield* Path.Path;
	const clean = path.normalize('/foo/bar//baz/asdf/quux/..');
	// "/foo/bar/baz/asdf"
});