Downloads

Download benefit schema and validated constructor; constructing a benefit does not authorize or deliver a file.

Declaration

const Downloads: Schema.Union<readonly [Schema.Struct<{
  type: Schema.tag<"download">;
  asset: Schema.Struct<{
     key: Schema.brand<Schema.String, "DownloadAssetKey">;
     revision: Schema.brand<Schema.Int, "DefinitionRevision">;
  }>;
  duration: Schema.Union<readonly [Schema.Literals<readonly ...>, Schema.Struct<{
     type: ...;
     months: ...;
     anchor: ...;
     calendar: ...;
  }>]>;
}>]> & {
  discriminants: readonly ["download"];
  cases: {
     download: Schema.Struct<{
        type: Schema.tag<"download">;
        asset: Schema.Struct<{
           key: Schema.brand<Schema.String, "DownloadAssetKey">;
           revision: Schema.brand<Schema.Int, "DefinitionRevision">;
        }>;
        duration: Schema.Union<readonly [Schema.Literals<readonly [..., ...]>, Schema.Struct<{
           type: Schema.tag<...>;
           months: Schema.brand<..., ...>;
           anchor: Schema.Literal<...>;
           calendar: Schema.Literal<...>;
        }>]>;
     }>;
  };
  isAnyOf: <Keys>(keys) => (value) => value is Extract<{ type: "download"; asset: { key: string & any; revision: number & any }; duration: "perpetual" | "purchased_period" | { type: "fixed"; months: number & any; anchor: "settlement"; calendar: "utc_clamped" } }, { type: Keys }>;
  guards: {
     download: (u) => u is { type: "download"; asset: { key: string & any; revision: number & any }; duration: "perpetual" | "purchased_period" | { type: "fixed"; months: number & any; anchor: "settlement"; calendar: "utc_clamped" } };
  };
  match: {
   <Cases>  (value, cases): Cases[keyof Cases] extends (value) => R ? any : never;
   <Cases>  (cases): (value) => Cases[keyof Cases] extends (value) => R ? any : never;
  };
} & {
  download: (input) => Effect.Effect<typeof DownloadBenefit.Type, Schema.SchemaError>;
};

Type Declaration

discriminants

readonly discriminants: readonly ["download"];

cases

readonly cases: {
  download: Schema.Struct<{
     type: Schema.tag<"download">;
     asset: Schema.Struct<{
        key: Schema.brand<Schema.String, "DownloadAssetKey">;
        revision: Schema.brand<Schema.Int, "DefinitionRevision">;
     }>;
     duration: Schema.Union<readonly [Schema.Literals<readonly [..., ...]>, Schema.Struct<{
        type: Schema.tag<...>;
        months: Schema.brand<..., ...>;
        anchor: Schema.Literal<...>;
        calendar: Schema.Literal<...>;
     }>]>;
  }>;
};

cases.download

download: Schema.Struct<{
  type: Schema.tag<"download">;
  asset: Schema.Struct<{
     key: Schema.brand<Schema.String, "DownloadAssetKey">;
     revision: Schema.brand<Schema.Int, "DefinitionRevision">;
  }>;
  duration: Schema.Union<readonly [Schema.Literals<readonly [..., ...]>, Schema.Struct<{
     type: Schema.tag<...>;
     months: Schema.brand<..., ...>;
     anchor: Schema.Literal<...>;
     calendar: Schema.Literal<...>;
  }>]>;
}>;

isAnyOf

readonly isAnyOf: <Keys>(keys) => (value) => value is Extract<{ type: "download"; asset: { key: string & any; revision: number & any }; duration: "perpetual" | "purchased_period" | { type: "fixed"; months: number & any; anchor: "settlement"; calendar: "utc_clamped" } }, { type: Keys }>;

Type Parameters

Keys

Keys

Parameters

keys

readonly Keys[]

Returns

(value) => value is Extract<{ type: “download”; asset: { key: string & any; revision: number & any }; duration: “perpetual” | “purchased_period” | { type: “fixed”; months: number & any; anchor: “settlement”; calendar: “utc_clamped” } }, { type: Keys }>

guards

readonly guards: {
  download: (u) => u is { type: "download"; asset: { key: string & any; revision: number & any }; duration: "perpetual" | "purchased_period" | { type: "fixed"; months: number & any; anchor: "settlement"; calendar: "utc_clamped" } };
};

guards.download

download: (u) => u is { type: "download"; asset: { key: string & any; revision: number & any }; duration: "perpetual" | "purchased_period" | { type: "fixed"; months: number & any; anchor: "settlement"; calendar: "utc_clamped" } };

Parameters

u

unknown

Returns

u is { type: “download”; asset: { key: string & any; revision: number & any }; duration: “perpetual” | “purchased_period” | { type: “fixed”; months: number & any; anchor: “settlement”; calendar: “utc_clamped” } }

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

type

"download"

asset

{ key: string & any; revision: number & any; }

asset.key

string & any

asset.revision

number & any

duration

| "perpetual" | "purchased_period" | { type: "fixed"; months: number & any; anchor: "settlement"; calendar: "utc_clamped"; }

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

download

download: (input) => Effect.Effect<typeof DownloadBenefit.Type, Schema.SchemaError>;

Parses download eligibility without requiring its wire-format tag.

Parameters

input

Omit<typeof DownloadBenefit.Encoded, "type">

Returns

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