Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 | 36x 36x 135x 8x 8x 8x 8x 135x | import {
assert,
literal,
number,
object,
optional,
union,
} from '@metamask/superstruct';
import { BaseError } from '../BaseError.ts';
import { marshaledErrorSchema, ErrorCode } from '../constants.ts';
import type { ErrorOptionsWithStack, MarshaledOcapError } from '../types.ts';
/**
* The type of resource limit that was exceeded.
*/
export type ResourceLimitType =
| 'connection'
| 'messageSize'
| 'messageRate'
| 'connectionRate';
/**
* Data associated with a ResourceLimitError.
*/
export type ResourceLimitErrorData = {
limitType?: ResourceLimitType;
current?: number;
limit?: number;
};
/**
* Error indicating a resource limit was exceeded.
*/
export class ResourceLimitError extends BaseError {
/**
* Creates a new ResourceLimitError.
*
* @param message - A human-readable description of the error.
* @param options - Additional error options including cause, stack, and data.
* @param options.data - Additional data about the error.
* @param options.data.limitType - The type of limit that was exceeded.
* @param options.data.current - The current value of the limit.
* @param options.data.limit - The limit value.
*/
constructor(
message: string,
options?: ErrorOptionsWithStack & {
data?: ResourceLimitErrorData;
},
) {
super(ErrorCode.ResourceLimitError, message, {
...options,
});
harden(this);
}
/**
* A superstruct struct for validating marshaled {@link ResourceLimitError} instances.
*/
public static struct = object({
...marshaledErrorSchema,
code: literal(ErrorCode.ResourceLimitError),
data: optional(
object({
limitType: optional(
union([
literal('connection'),
literal('messageSize'),
literal('messageRate'),
literal('connectionRate'),
]),
),
current: optional(number()),
limit: optional(number()),
}),
),
});
/**
* Unmarshals a {@link MarshaledError} into a {@link ResourceLimitError}.
*
* @param marshaledError - The marshaled error to unmarshal.
* @param unmarshalErrorOptions - The function to unmarshal the error options.
* @returns The unmarshaled error.
*/
public static unmarshal(
marshaledError: MarshaledOcapError,
unmarshalErrorOptions: (
marshaledError: MarshaledOcapError,
) => ErrorOptionsWithStack,
): ResourceLimitError {
assert(marshaledError, this.struct);
const options = unmarshalErrorOptions(marshaledError);
const data = marshaledError.data as ResourceLimitErrorData | undefined;
return new ResourceLimitError(marshaledError.message, {
...options,
...(data !== undefined && { data }),
});
}
}
harden(ResourceLimitError);
|