extname (function)

Returns the file extension of the file at a given path.

If the file has no extension (eg Makefile, etc), then '' will be returned.

• @param pathOrFilename — The input path
• @param options — Options which affect the return value. See ExtnameOptions.

Example

const extension = extname("src/index.test.ts");
console.log(extension); // .ts

declare function extname(
  pathOrFilename: string | Path,
  options?: ExtnameOptions,
): string;

ExtnameOptions (interface)

Options for extname and Path.prototype.extname.

Example

const options: ExtnameOptions = { full: true };
console.log(extname("types.d.ts", options)); // .d.ts

declare interface ExtnameOptions {
  full?: boolean;
}

ExtnameOptions.full (boolean property)

Whether to get compound extensions, like .d.ts or .test.js, instead of just the final extension (.ts or .js in this example).

Example

console.log(extname("types.d.ts", { full: true })); // .d.ts
console.log(extname("types.d.ts", { full: false })); // .ts

full?: boolean;