Function lstatSync

  • lstatSync(path, options?): Stats

  • Synchronous lstat(2) - Get file status. Does not dereference symbolic links.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • Optional options: undefined

    Returns Stats

  • lstatSync(path, options?): undefined | Stats

  • Synchronous lstat(2) - Get file status. Does not dereference symbolic links.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • Optional options: StatSyncOptions & {
          bigint?: false;
          throwIfNoEntry: false;
      }

    Returns undefined | Stats

  • lstatSync(path, options): undefined | BigIntStats

  • Synchronous lstat(2) - Get file status. Does not dereference symbolic links.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • options: StatSyncOptions & {
          bigint: true;
          throwIfNoEntry: false;
      }

    Returns undefined | BigIntStats

  • lstatSync(path, options?): Stats

  • Synchronous lstat(2) - Get file status. Does not dereference symbolic links.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • Optional options: StatSyncOptions & {
          bigint?: false;
      }

    Returns Stats

  • lstatSync(path, options): BigIntStats

  • Synchronous lstat(2) - Get file status. Does not dereference symbolic links.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • options: StatSyncOptions & {
          bigint: true;
      }

    Returns BigIntStats

  • lstatSync(path, options): Stats | BigIntStats

  • Synchronous lstat(2) - Get file status. Does not dereference symbolic links.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • options: StatSyncOptions & {
          bigint: boolean;
          throwIfNoEntry?: false;
      }

    Returns Stats | BigIntStats

  • lstatSync(path, options?): undefined | Stats | BigIntStats

  • Synchronous lstat(2) - Get file status. Does not dereference symbolic links.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • Optional options: StatSyncOptions

    Returns undefined | Stats | BigIntStats

Properties

[metadata] arguments caller length name prototype

Methods

[hasInstance] apply bind call toString

Properties

[metadata]

[metadata]: null | DecoratorMetadataObject

arguments

arguments: any

caller

caller: Function

Readonly length

length: number

Readonly name

name: string

Returns the name of the function. Function names are read-only and can not be changed.

prototype

prototype: any

Methods

[hasInstance]

  • [hasInstance](value): boolean

  • Determines whether the given value inherits from this function if this function was used as a constructor function.

    A constructor function can control which objects are recognized as its instances by 'instanceof' by overriding this method.

    Parameters

    • value: any

    Returns boolean

apply

  • apply(this, thisArg, argArray?): any

  • Calls the function, substituting the specified object for the this value of the function, and the specified array for the arguments of the function.

    Parameters

    • this: Function
    • thisArg: any

      The object to be used as the this object.

    • Optional argArray: any

      A set of arguments to be passed to the function.

    Returns any

bind

  • bind(this, thisArg, ...argArray): any

  • For a given function, creates a bound function that has the same body as the original function. The this object of the bound function is associated with the specified object, and has the specified initial parameters.

    Parameters

    • this: Function
    • thisArg: any

      An object to which the this keyword can refer inside the new function.

    • Rest ...argArray: any[]

      A list of arguments to be passed to the new function.

    Returns any

call

  • call(this, thisArg, ...argArray): any

  • Calls a method of an object, substituting another object for the current object.

    Parameters

    • this: Function
    • thisArg: any

      The object to be used as the current object.

    • Rest ...argArray: any[]

      A list of arguments to be passed to the method.

    Returns any

toString

  • toString(): string

  • Returns a string representation of a function.

    Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc