Skip to content

Latest commit

 

History

History
184 lines (99 loc) · 2.7 KB

UsageError.md

File metadata and controls

184 lines (99 loc) · 2.7 KB
Raw

@actions/artifact / UsageError

Class: UsageError

Hierarchy

  • Error

    ↳ UsageError

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new UsageError(): UsageError

Returns

UsageError

Overrides

Error.constructor

Defined in

src/internal/shared/errors.ts:62

Properties

message

• message: string

Inherited from

Error.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1068

name

• name: string

Inherited from

Error.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1067

stack

• Optional stack: string

Inherited from

Error.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1069

prepareStackTrace

▪ Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration

▸ (err, stackTraces): any

Optional override for formatting stack traces

Parameters
Name Type
err Error
stackTraces CallSite[]
Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:11

stackTraceLimit

▪ Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:13

Methods

captureStackTrace

▸ captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Name Type
targetObject object
constructorOpt? Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:4

isUsageErrorMessage

▸ isUsageErrorMessage(msg?): boolean

Parameters

Name Type
msg? string

Returns

boolean

Defined in

src/internal/shared/errors.ts:68