Function ErrorInstance

packages/effect/src/Schema.ts:10669–10693

(options?: ErrorOptions)

 * @since 4.0.0
 */
export function ErrorInstance(options?: ErrorOptions): ErrorInstance {
  const key = getErrorOptionsKey(options)
  const cached = errorSchemaCache[key]
  if (cached !== undefined) {
    return cached
  }
  const normalizedOptions = getErrorOptions(key)
  const schema = instanceOf(globalThis.Error, {
    representation: {
      id: "effect/schema/Error",
      payload: normalizedOptions ?? null
    },
    toCode: () => ({
      runtime: normalizedOptions !== undefined
        ? `Schema.ErrorInstance(${format(normalizedOptions)})`
        : `Schema.ErrorInstance()`,
      Type: `globalThis.Error`
    }),
    expected: "Error",
    toCodecJson: () => link<globalThis.Error>()(JsonError, SchemaTransformation.errorFromJsonError(normalizedOptions)),
    toArbitrary: () => (fc) => fc.string().map((message) => new globalThis.Error(message))
  })
  errorSchemaCache[key] = schema
  return schema
}

/**
 * Reviver for persisted {@link ErrorInstance} declarations.