Go's filepath.Base in TypeScript

How to use

Install via yarn add locutus and import: import { Base } from 'locutus/golang/filepath/Base'.

Or with CommonJS: const { Base } = require('locutus/golang/filepath/Base')

Use a bundler that supports tree-shaking so you only ship the functions you actually use. Vite, webpack, Rollup, and Parcel all handle this. For server-side use this is less of a concern.

Examples

These examples are extracted from test cases that automatically verify our functions against their native counterparts.

#	code	expected result
1	Base('/a/b/c.txt')	'c.txt'
2	Base('/a/b/')	'b'
3	Base('')	'.'
4	Base('////')	'/'

Notes

• Mirrors path/filepath.Base for slash-separated paths on the Go parity target.

Here's what our current TypeScript equivalent to Go's filepath.Base looks like.

TSTypeScript JSJavaScript TSStandalone TS JSStandalone JS

Copy code

export function Base(path: string): string {
  //      discuss at: https://locutus.io/golang/filepath/Base
  // parity verified: Go 1.23
  //     original by: Kevin van Zonneveld (https://kvz.io)
  //          note 1: Mirrors path/filepath.Base for slash-separated paths on the Go parity target.
  //       example 1: Base('/a/b/c.txt')
  //       returns 1: 'c.txt'
  //       example 2: Base('/a/b/')
  //       returns 2: 'b'
  //       example 3: Base('')
  //       returns 3: '.'
  //       example 4: Base('////')
  //       returns 4: '/'

  const raw = String(path)
  if (raw === '') {
    return '.'
  }

  let end = raw.length
  while (end > 0 && raw[end - 1] === '/') {
    end -= 1
  }

  if (end === 0) {
    return '/'
  }

  const trimmed = raw.slice(0, end)
  const slash = trimmed.lastIndexOf('/')
  if (slash < 0) {
    return trimmed
  }

  return trimmed.slice(slash + 1)
}

export function Base(path) {
  //      discuss at: https://locutus.io/golang/filepath/Base
  // parity verified: Go 1.23
  //     original by: Kevin van Zonneveld (https://kvz.io)
  //          note 1: Mirrors path/filepath.Base for slash-separated paths on the Go parity target.
  //       example 1: Base('/a/b/c.txt')
  //       returns 1: 'c.txt'
  //       example 2: Base('/a/b/')
  //       returns 2: 'b'
  //       example 3: Base('')
  //       returns 3: '.'
  //       example 4: Base('////')
  //       returns 4: '/'

  const raw = String(path)
  if (raw === '') {
    return '.'
  }

  let end = raw.length
  while (end > 0 && raw[end - 1] === '/') {
    end -= 1
  }

  if (end === 0) {
    return '/'
  }

  const trimmed = raw.slice(0, end)
  const slash = trimmed.lastIndexOf('/')
  if (slash < 0) {
    return trimmed
  }

  return trimmed.slice(slash + 1)
}

Improve this function

Locutus is a community effort following The McDonald's Theory: we ship first iterations, hoping others will improve them. If you see something that could be better, we'd love your contribution.

View on GitHub · Edit on GitHub · View Raw

---

Help us add more

Got a rainy Sunday afternoon and a taste for a porting puzzle?

• Get inspiration from Go strings documentation, Go strings source, Go strings examples source, GopherJS.
• Click "New file" in the appropriate folder on GitHub. This will fork the project to your account, directly add the file to it, and send a Pull Request to us.

We will then review it. If it's useful to the project and in line with our contributing guidelines your work will become part of Locutus and you'll be automatically credited in the authors section accordingly.

« More Go filepath functions

Star