ts-primitives

Index

Namespaces

Enumerations

CharCode

Interfaces

Type aliases

Listener

Variables

Functions

Type aliases

Listener

Listener<T>: [] | ((e: T) => void)

Type parameters

Variables

Const basename

basename: (path: string, ext?: string) => string

Type declaration

- (path: string, ext?: string): string
- Parameters
  - path: string
  - Optional ext: string
  Returns string

Const delimiter

delimiter: string

Const dirname

dirname: (path: string) => string

Type declaration

- (path: string): string
- Parameters
  - path: string
  Returns string

Const extname

extname: (path: string) => string

Type declaration

- (path: string): string
- Parameters
  - path: string
  Returns string

Const format

format: (pathObject: ParsedPath) => string

Type declaration

- (pathObject: ParsedPath): string
- Parameters
  - pathObject: ParsedPath
  Returns string

Const isAbsolute

isAbsolute: (path: string) => boolean

Type declaration

- (path: string): boolean
- Parameters
  - path: string
  Returns boolean

Const join

join: (...paths: string[]) => string

Type declaration

- (...paths: string[]): string
- Parameters
  - Rest ...paths: string[]
  Returns string

Const normalize

normalize: (path: string) => string

Type declaration

- (path: string): string
- Parameters
  - path: string
  Returns string

Const parse

parse: (path: string) => ParsedPath

Type declaration

- (path: string): ParsedPath
- Parameters
  - path: string
  Returns ParsedPath

Const posix

posix: IPath

Const relative

relative: (from: string, to: string) => string

Type declaration

- (from: string, to: string): string
- Parameters
  - from: string
  - to: string
  Returns string

Const resolve

resolve: (...pathSegments: string[]) => string

Type declaration

- (...pathSegments: string[]): string
- Parameters
  - Rest ...pathSegments: string[]
  Returns string

Const sep

sep: "\" | "/"

Const toNamespacedPath

toNamespacedPath: (path: string) => string

Type declaration

- (path: string): string
- Parameters
  - path: string
  Returns string

Const win32

win32: IPath

Functions

asPromise

asPromise<T>(callback: () => T | Thenable<T>): Promise<T>

- Defined in dist/index.d.ts:531
Type parameters
- T
Parameters
- callback: () => T | Thenable<T>
  - - (): T | Thenable<T>
    - Returns T | Thenable<T>
Returns Promise<T>

combinedDisposable

combinedDisposable(...disposables: IDisposable[]): IDisposable

- Defined in dist/index.d.ts:20
Parameters
- Rest ...disposables: IDisposable[]
Returns IDisposable

createCancelablePromise

createCancelablePromise<T>(callback: (token: CancellationToken) => Promise<T>): CancelablePromise<T>

- Defined in dist/index.d.ts:528
Type parameters
- T
Parameters
- callback: (token: CancellationToken) => Promise<T>
  - - (token: CancellationToken): Promise<T>
    - Parameters
      - token: CancellationToken
      Returns Promise<T>
Returns CancelablePromise<T>

disposableTimeout

disposableTimeout(handler: () => void, timeout?: number): IDisposable

- Defined in dist/index.d.ts:641
Parameters
- handler: () => void
  - - (): void
    - Returns void
- Optional timeout: number
Returns IDisposable

dispose

dispose<T>(disposable: T): T
dispose<T>(disposable: T | undefined): T | undefined
dispose<T, A>(disposables: IterableIterator<T>): A
dispose<T>(disposables: Array<T>): Array<T>
dispose<T>(disposables: ReadonlyArray<T>): ReadonlyArray<T>

- Defined in dist/index.d.ts:15
Type parameters
- T: IDisposable
Parameters
- disposable: T
Returns T
- Defined in dist/index.d.ts:16
Type parameters
- T: IDisposable
Parameters
- disposable: T | undefined
Returns T | undefined
- Defined in dist/index.d.ts:17
Type parameters
- T: IDisposable
- A: IterableIterator<T>
Parameters
- disposables: IterableIterator<T>
Returns A
- Defined in dist/index.d.ts:18
Type parameters
- T: IDisposable
Parameters
- disposables: Array<T>
Returns Array<T>
- Defined in dist/index.d.ts:19
Type parameters
- T: IDisposable
Parameters
- disposables: ReadonlyArray<T>
Returns ReadonlyArray<T>

first

first<T>(promiseFactories: ITask<Promise<T>>[], shouldStop?: (t: T) => boolean, defaultValue?: T | null): Promise<T | null>

- Defined in dist/index.d.ts:648
Type parameters
- T
Parameters
- promiseFactories: ITask<Promise<T>>[]
- Optional shouldStop: (t: T) => boolean
  - - (t: T): boolean
    - Parameters
      - t: T
      Returns boolean
- Optional defaultValue: T | null
Returns Promise<T | null>

ignoreErrors

ignoreErrors<T>(promise: Promise<T>): Promise<T | undefined>

- Defined in dist/index.d.ts:642
Type parameters
- T
Parameters
- promise: Promise<T>
Returns Promise<T | undefined>

isDisposable

isDisposable<E>(thing: E): thing is E & IDisposable

- Defined in dist/index.d.ts:14
Type parameters
- E: object
Parameters
- thing: E
Returns thing is E & IDisposable

isThenable

isThenable<T>(obj: any): obj is Promise<T>

- Defined in dist/index.d.ts:524
Type parameters
- T
Parameters
- obj: any
Returns obj is Promise<T>

raceCancellation

raceCancellation<T>(promise: Promise<T>, token: CancellationToken): Promise<T | undefined>
raceCancellation<T>(promise: Promise<T>, token: CancellationToken, defaultValue: T): Promise<T>

- Defined in dist/index.d.ts:529
Type parameters
- T
Parameters
- promise: Promise<T>
- token: CancellationToken
Returns Promise<T | undefined>
- Defined in dist/index.d.ts:530
Type parameters
- T
Parameters
- promise: Promise<T>
- token: CancellationToken
- defaultValue: T
Returns Promise<T>

retry

retry<T>(task: ITask<Promise<T>>, delay: number, retries: number): Promise<T>

- Defined in dist/index.d.ts:674
Type parameters
- T
Parameters
- task: ITask<Promise<T>>
- delay: number
- retries: number
Returns Promise<T>

sequence

sequence<T>(promiseFactories: ITask<Promise<T>>[]): Promise<T[]>

- Defined in dist/index.d.ts:647
Runs the provided list of promise factories in sequential order. The returned promise will complete to an array of results from each promise.

Type parameters
- T
Parameters
- promiseFactories: ITask<Promise<T>>[]
Returns Promise<T[]>

setDisposableTracker

setDisposableTracker(tracker: IDisposableTracker | null): void

- Defined in dist/index.d.ts:5
Parameters
- tracker: IDisposableTracker | null
Returns void

setGlobalLeakWarningThreshold

setGlobalLeakWarningThreshold(n: number): IDisposable

- Defined in dist/index.d.ts:252
Parameters
- n: number
Returns IDisposable

timeout

timeout(millis: number): CancelablePromise<void>
timeout(millis: number, token: CancellationToken): Promise<void>

- Defined in dist/index.d.ts:639
Parameters
- millis: number
Returns CancelablePromise<void>
- Defined in dist/index.d.ts:640
Parameters
- millis: number
- token: CancellationToken
Returns Promise<void>

toDisposable

toDisposable(fn: () => void): IDisposable

- Defined in dist/index.d.ts:21
Parameters
- fn: () => void
  - - (): void
    - Returns void
Returns IDisposable

trackDisposable

trackDisposable<T>(x: T): T

- Defined in dist/index.d.ts:6
Type parameters
- T: IDisposable
Parameters
- x: T
Returns T

uriToFsPath

uriToFsPath(uri: URI, keepDriveLetterCasing: boolean): string

- Defined in dist/index.d.ts:523
Compute fsPath for the given uri

Parameters
- uri: URI
- keepDriveLetterCasing: boolean
Returns string

Index

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

Listener

Type parameters

T

Variables

Const basename

Type declaration

Parameters

path: string

Optional ext: string

Returns string

Const delimiter

Const dirname

Type declaration

Parameters

path: string

Returns string

Const extname

Type declaration

Parameters

path: string

Returns string

Const format

Type declaration

Parameters

pathObject: ParsedPath

Returns string

Const isAbsolute

Type declaration

Parameters

path: string

Returns boolean

Const join

Type declaration

Parameters

Rest ...paths: string[]

Returns string

Const normalize

Type declaration

Parameters

path: string

Returns string

Const parse

Type declaration

Parameters

path: string

Returns ParsedPath

Const posix

Const relative

Type declaration

Parameters

from: string

to: string

Returns string

Const resolve

Type declaration

Parameters

Rest ...pathSegments: string[]

Returns string

Const sep

Const toNamespacedPath

Type declaration

Parameters

path: string

Returns string

Const win32

Functions

asPromise

Type parameters

T

Parameters

callback: () => T | Thenable<T>