# Class InvalidEncoding

#### Hierarchy (View Summary)

- ActorError
  - InvalidEncoding

- Defined in rivetkit-typescript/packages/rivetkit/src/actor/errors.ts:123

##### Index

### Constructors

constructor

### Properties

__type
cause?
code
group
message
metadata?
name
public
stack?
statusCode
stackTraceLimit

### Methods

toString
captureStackTrace
isActorError
isError
prepareStackTrace

## Constructors

### constructor

- new InvalidEncoding(format?: string): InvalidEncoding

  #### Parameters

  - `Optional` format: string

  #### Returns InvalidEncoding

  Overrides ActorError.constructor

  - Defined in rivetkit-typescript/packages/rivetkit/src/actor/errors.ts:124

## Properties

### __type

__type: string = "ActorError"

Inherited from ActorError.__type

- Defined in rivetkit-typescript/packages/rivetkit/src/actor/errors.ts:18

### `Optional` cause

cause?: unknown

Inherited from ActorError.cause

- Defined in node_modules/.pnpm/typescript@5.9.2/node_modules/typescript/lib/lib.es2022.error.d.ts:26

### `Readonly` code

code: string

Inherited from ActorError.code

- Defined in rivetkit-typescript/packages/rivetkit/src/actor/errors.ts:24

### `Readonly` group

group: string

Inherited from ActorError.group

- Defined in rivetkit-typescript/packages/rivetkit/src/actor/errors.ts:23

### message

message: string

Inherited from ActorError.message

- Defined in node_modules/.pnpm/typescript@5.9.2/node_modules/typescript/lib/lib.es5.d.ts:1077

### `Optional` metadata

metadata?: unknown

Inherited from ActorError.metadata

- Defined in rivetkit-typescript/packages/rivetkit/src/actor/errors.ts:21

### name

name: string

Inherited from ActorError.name

- Defined in node_modules/.pnpm/typescript@5.9.2/node_modules/typescript/lib/lib.es5.d.ts:1076

### public

public: boolean

Inherited from ActorError.public

- Defined in rivetkit-typescript/packages/rivetkit/src/actor/errors.ts:20

### `Optional` stack

stack?: string

Inherited from ActorError.stack

- Defined in node_modules/.pnpm/typescript@5.9.2/node_modules/typescript/lib/lib.es5.d.ts:1078

### statusCode

statusCode: number = 500

Inherited from ActorError.statusCode

- Defined in rivetkit-typescript/packages/rivetkit/src/actor/errors.ts:22

### `Static` stackTraceLimit

stackTraceLimit: number

The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`).

The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from ActorError.stackTraceLimit

- Defined in node_modules/.pnpm/@types+node@22.18.1/node_modules/@types/node/globals.d.ts:68

## Methods

### toString

- toString(): string

  Returns a string representation of an object.

  #### Returns string

  Inherited from ActorError.toString

  - Defined in rivetkit-typescript/packages/rivetkit/src/actor/errors.ts:53

### `Static` captureStackTrace

- captureStackTrace(targetObject: object, constructorOpt?: Function): void

  Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which `Error.captureStackTrace()` was called.

      const myObject = {};
      Error.captureStackTrace(myObject);
      myObject.stack;  // Similar to `new Error().stack`

  The first line of the trace will be prefixed with `${myObject.name}: ${myObject.message}`.

  The optional `constructorOpt` argument accepts a function. If given, all frames above `constructorOpt`, including `constructorOpt`, will be omitted from the generated stack trace.

  The `constructorOpt` argument is useful for hiding implementation details of error generation from the user. For instance:

      function a() {
        b();
      }

      function b() {
        c();
      }

      function c() {
        // Create an error without stack trace to avoid calculating the stack trace twice.
        const { stackTraceLimit } = Error;
        Error.stackTraceLimit = 0;
        const error = new Error();
        Error.stackTraceLimit = stackTraceLimit;

        // Capture the stack trace above function b
        Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
        throw error;
      }

      a();

  #### Parameters

  - targetObject: object
  - `Optional` constructorOpt: Function

  #### Returns void

  Inherited from ActorError.captureStackTrace

  - Defined in node_modules/.pnpm/@types+node@22.18.1/node_modules/@types/node/globals.d.ts:52

### `Static` isActorError

- isActorError(error: unknown): error is ActorError | DeconstructedError

  #### Parameters

  - error: unknown

  #### Returns error is ActorError | DeconstructedError

  Inherited from ActorError.isActorError

  - Defined in rivetkit-typescript/packages/rivetkit/src/actor/errors.ts:26

### `Static` isError

- isError(error: unknown): error is Error

  Indicates whether the argument provided is a built-in Error instance or not.

  #### Parameters

  - error: unknown

  #### Returns error is Error

  Inherited from ActorError.isError

  - Defined in node_modules/.pnpm/typescript@5.9.2/node_modules/typescript/lib/lib.esnext.error.d.ts:23

### `Static` prepareStackTrace

- prepareStackTrace(err: Error, stackTraces: CallSite[]): any

  #### Parameters

  - err: Error
  - stackTraces: CallSite[]

  #### Returns any

  #### See

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

  Inherited from ActorError.prepareStackTrace

  - Defined in node_modules/.pnpm/@types+node@22.18.1/node_modules/@types/node/globals.d.ts:56