Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@safelytyped/filepath

SafelyTyped1BSD-3-Clause0.2.0TypeScript support: included

A safe type for working with locations on local filesystems, for Typescript.

readme

Welcome To @safelytyped/filepath!

Introduction

ADD YOUR INTRODUCTION HERE!!

Quick Start

# run this from your Terminal
npm install @safelytyped/filepath
// add this import to your Typescript code
import { Value } from "@safelytyped/filepath"

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.

changelog

CHANGELOG

Introduction

This CHANGELOG tells you:

  • when a release was made
  • what is in each release

It also tells you what changes have been completed, and will be included in the next tagged release.

For each release, changes are grouped under these headings:

  • Backwards-Compatibility Breaks: a list of any backwards-compatibility breaks
  • New: a list of new features. If the feature came from a contributor via a PR, make sure you link to the PR and give them a mention here.
  • Fixes: a list of bugs that have been fixed. If there's an issue for the bug, make sure you link to the GitHub issue here.
  • Dependencies: a list of dependencies that have been added / updated / removed.
  • Tools: a list of bundled tools that have been added / updated / removed.

develop branch

The following changes have been completed, and will be included in the next tagged release.

v0.2.0

Released Saturday, 2nd March 2024.

Fixes

  • Added simultaneous support for CommonJS and ESM runtime environments

Dependencies

  • Upgraded to Typescript v5.2

Tools

  • Switched from tslint to eslint

v0.1.1

Released Wednesday, 26th May 2021.

Dependencies

  • Upgraded all dependencies to the latest version.

v0.1.0

Released Tuesday, 23rd June 2020.

New

  • Errors
    • added InvalidFilepathDataError
  • Filepath
    • added Filepath
      • added Filepath base option
      • added Filepath pathApi option
      • added Filepath.basename()
      • added Filepath.dirname()
      • added Filepath.extname()
      • added Filepath.isAbsolute()
      • added Filepath.join()
      • added Filepath.parse()
      • added Filepath.relative()
      • added Filepath.resolve()
      • added Filepath.toNamespacedPath()
    • added MakeFilepathOptions
    • added isFilepathData()
    • added makeFilepath()
    • added mustBeFilepath()
    • added validateFilepathData()