Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AsyncFileLock

A lock on a region of an AsyncFile.

Hierarchy

  • AsyncFileLock

Index

Methods

Methods

isShared

  • isShared(): boolean

  • Returns boolean

isValid

  • Like {@link AsyncFileLock#isValid} but the handler will be called when the operation completes or if an error occurs.

    Returns PromiseLike<boolean>

  • Like {@link AsyncFileLock#isValid} but the handler will be called when the operation completes or if an error occurs.

    Parameters

    Returns void

isValidBlocking

  • isValidBlocking(): boolean

  • Like {@link AsyncFileLock#isValid} but blocking.

    Returns boolean

overlaps

  • overlaps(position: number, size: number): boolean

  • Parameters

    • position: number
    • size: number

    Returns boolean

position

  • position(): number

  • Returns number

release

  • Like {@link AsyncFileLock#release} but the handler will be called when the operation completes or if an error occurs.

    Returns PromiseLike<void>

  • Like {@link AsyncFileLock#release} but the handler will be called when the operation completes or if an error occurs.

    Parameters

    Returns void

releaseBlocking

  • releaseBlocking(): void

  • Like {@link AsyncFileLock#release} but blocking.

    Returns void

size

  • size(): number

  • Returns number

Generated using TypeDoc