README.md

Welcome To @safelytyped/node-pathapi!

Introduction

@safelytyped/node-pathapi is a protocol library.

It provides a Typescript interface for the NodeJS path module methods that work on both POSIX and Windows (ie, the interface that describes both path.posix and path.win32).

Use it to help you test libraries that take path as a dependency. See the Filepath safe type for a working example.

Quick Start

# run this from your Terminal
npm install @safelytyped/node-pathapi

// add this import to your Typescript code
import { PathApi } from "@safelytyped/node-pathapi"

VS Code users: once you've added a single import anywhere in your project, you'll then be able to auto-import anything else that this library exports.

Documentation

Looking for more detailed documentation? You'll find it under the docs folder.

Plus:

• The PathApi itself.
• Our CHANGELOG
• Our software license
• All contributors to date