Function pathToFileURL

  • This function ensures that path is resolved absolutely, and that the URL control characters are correctly encoded when converting into a File URL.

    import { pathToFileURL } from 'url';

    new URL('/foo#1', 'file:');           // Incorrect: file:///foo#1
    pathToFileURL('/foo#1');              // Correct:   file:///foo%231 (POSIX)

    new URL('/some/path%.c', 'file:');    // Incorrect: file:///some/path%.c
    pathToFileURL('/some/path%.c');       // Correct:   file:///some/path%25.c (POSIX)

    Since

    v10.12.0

    Returns

    The file URL object.

    Parameters

    • path: string

      The path to convert to a File URL.

    Returns "url".URL

  • This function ensures that path is resolved absolutely, and that the URL control characters are correctly encoded when converting into a File URL.

    import { pathToFileURL } from 'url';

    new URL('/foo#1', 'file:');           // Incorrect: file:///foo#1
    pathToFileURL('/foo#1');              // Correct:   file:///foo%231 (POSIX)

    new URL('/some/path%.c', 'file:');    // Incorrect: file:///some/path%.c
    pathToFileURL('/some/path%.c');       // Correct:   file:///some/path%25.c (POSIX)

    Since

    v10.12.0

    Returns

    The file URL object.

    Parameters

    • path: string

      The path to convert to a File URL.

    Returns "url".URL

Settings

Member Visibility

Theme

Generated using TypeDoc