Credits

Usage credit benefit schema and validated constructor; construction does not credit a balance.

Declaration

const Credits: Schema.Union<readonly [Schema.Struct<{
  unit: Schema.brand<Schema.String, "UsageUnitKey">;
  quantity: Schema.brand<Schema.BigInt, "UsageCreditQuantity">;
  expiry: Schema.Literal<"never">;
  type: Schema.tag<"usage_credits">;
}>]> & {
  discriminants: readonly ["usage_credits"];
  cases: {
     usage_credits: Schema.Struct<{
        unit: Schema.brand<Schema.String, "UsageUnitKey">;
        quantity: Schema.brand<Schema.BigInt, "UsageCreditQuantity">;
        expiry: Schema.Literal<"never">;
        type: Schema.tag<"usage_credits">;
     }>;
  };
  isAnyOf: <Keys>(keys) => (value) => value is Extract<{ unit: string & any; quantity: bigint & any; expiry: "never"; type: "usage_credits" }, { type: Keys }>;
  guards: {
     usage_credits: (u) => u is { unit: string & any; quantity: bigint & any; expiry: "never"; type: "usage_credits" };
  };
  match: {
   <Cases>  (value, cases): Cases[keyof Cases] extends (value) => R ? any : never;
   <Cases>  (cases): (value) => Cases[keyof Cases] extends (value) => R ? any : never;
  };
} & {
  pack: (input) => Effect.Effect<typeof CreditBenefit.Type, Schema.SchemaError>;
};

Type Declaration

discriminants

readonly discriminants: readonly ["usage_credits"];

cases

readonly cases: {
  usage_credits: Schema.Struct<{
     unit: Schema.brand<Schema.String, "UsageUnitKey">;
     quantity: Schema.brand<Schema.BigInt, "UsageCreditQuantity">;
     expiry: Schema.Literal<"never">;
     type: Schema.tag<"usage_credits">;
  }>;
};

cases.usage_credits

usage_credits: Schema.Struct<{
  unit: Schema.brand<Schema.String, "UsageUnitKey">;
  quantity: Schema.brand<Schema.BigInt, "UsageCreditQuantity">;
  expiry: Schema.Literal<"never">;
  type: Schema.tag<"usage_credits">;
}>;

isAnyOf

readonly isAnyOf: <Keys>(keys) => (value) => value is Extract<{ unit: string & any; quantity: bigint & any; expiry: "never"; type: "usage_credits" }, { type: Keys }>;

Type Parameters

Keys

Keys

Parameters

keys

readonly Keys[]

Returns

(value) => value is Extract<{ unit: string & any; quantity: bigint & any; expiry: "never"; type: "usage_credits" }, { type: Keys }>

guards

readonly guards: {
  usage_credits: (u) => u is { unit: string & any; quantity: bigint & any; expiry: "never"; type: "usage_credits" };
};

guards.usage_credits

usage_credits: (u) => u is { unit: string & any; quantity: bigint & any; expiry: "never"; type: "usage_credits" };

Parameters

u

unknown

Returns

u is { unit: string & any; quantity: bigint & any; expiry: "never"; type: "usage_credits" }

match

readonly match: {
<Cases>  (value, cases): Cases[keyof Cases] extends (value) => R ? any : never;
<Cases>  (cases): (value) => Cases[keyof Cases] extends (value) => R ? any : never;
};

Call Signature

<Cases>(value, cases): Cases[keyof Cases] extends (value) => R ? any : never;

Type Parameters

Cases

Cases extends { [key: string]: (value) => any; }

Parameters

value

unit

string & any

quantity

bigint & any

expiry

"never"

type

"usage_credits"

cases

Cases

Returns

Cases[keyof Cases] extends (value) => R ? any : never

Call Signature

<Cases>(cases): (value) => Cases[keyof Cases] extends (value) => R ? any : never;

Type Parameters

Cases

Cases extends { [key: string]: (value) => any; }

Parameters

cases

Cases

Returns

(value) => Cases[keyof Cases] extends (value) => R ? any : never

Type Declaration

pack

pack: (input) => Effect.Effect<typeof CreditBenefit.Type, Schema.SchemaError>;

Parses a non-expiring usage credit pack without fixed wire-format fields.

Parameters

input

Omit<typeof CreditBenefit.Encoded, "type" | "expiry">

Returns

Effect.Effect<typeof CreditBenefit.Type, Schema.SchemaError>