Skip to content

@codesoul-co/hypha-core / modules/execution-cache/index

Using this module

Use the Index module for executing runtime behavior at this boundary. It exports 23 constants, 9 functions.

Import from the package entrypoint

ts
import {
  executionCacheArtifactReferenceJsonSchema,
  executionCacheArtifactReferenceSchema,
  executionCacheEntryProjectionExample,
  executionCacheEntryProjectionJsonSchema,
  executionCacheEntryProjectionSchema,
  executionCacheJsonSchemas,
  executionCacheRecordJsonSchema,
  executionCacheRecordSchema,
} from '@codesoul-co/hypha-core';

// The complete export list is documented below.

Usage patterns

  • The module exposes 9 functions as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.
  • The 23 constant/enum exports provide stable values, schemas, definitions, or defaults. Reuse these exports instead of copying internal values into an application.

Runtime validation example

ts
import { executionCacheArtifactReferenceSchema } from '@codesoul-co/hypha-core';

declare function loadExternalInput(): unknown;
const input: unknown = loadExternalInput();
const parsed = executionCacheArtifactReferenceSchema.parse(input);

Parse untrusted configuration, network, or persisted input with the runtime schema before passing it to functions or classes that expect a validated contract.

Public exports

SymbolKindSignatureDescription
executionCacheArtifactReferenceJsonSchemaconstantconst executionCacheArtifactReferenceJsonSchema: JsonSchemaJSON Schema for Execution Cache Artifact Reference.
executionCacheArtifactReferenceSchemaconstantconst executionCacheArtifactReferenceSchema: z.ZodObject<{ artifactRef: z.ZodString; contentHash: z.ZodString; }, "strict", z.ZodTypeAny, { contentHash: string; artifactRef: string; }, { contentHash: string; artifactRef: string; }>Runtime schema for Execution Cache Artifact Reference.
executionCacheEntryProjectionExampleconstantconst executionCacheEntryProjectionExample: ExecutionCacheEntryProjectionValid example value for Execution Cache Entry Projection.
executionCacheEntryProjectionJsonSchemaconstantconst executionCacheEntryProjectionJsonSchema: JsonSchemaJSON Schema for Execution Cache Entry Projection.
executionCacheEntryProjectionSchemaconstantconst executionCacheEntryProjectionSchema: z.ZodEffects<z.ZodObject<{ commandHash: z.ZodString; validityHash: z.ZodString; validity: z.ZodObject<{ executable: z.ZodString; argsHash: z.ZodString; sourceTreeHash: z.ZodString; workspaceSnapshotHash: z.ZodOptional<z.ZodString>; environmentHash: z.ZodString; imageDigest: z.ZodOptional<z.ZodString>; dependencyLockHash: z.ZodOptional<z.ZodString>; networkPolicyHash: z.Zo...Runtime schema for Execution Cache Entry Projection.
executionCacheJsonSchemasconstantconst executionCacheJsonSchemas: Record<string, JsonSchema>Execution Cache JSON Schemas constant exported by the modules/execution-cache/index module.
executionCacheRecordJsonSchemaconstantconst executionCacheRecordJsonSchema: JsonSchemaJSON Schema for Execution Cache Record.
executionCacheRecordSchemaconstantconst executionCacheRecordSchema: z.ZodEffects<z.ZodObject<{ schemaVersion: z.ZodLiteral<"1.0">; keyVersion: z.ZodLiteral<"1">; key: z.ZodString; scope: z.ZodObject<{ tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodString; workspaceId: z.ZodString; }, "strict", z.ZodTypeAny, { workspaceId: string; userId: string; tenantId?: string | undefined; }, { workspaceId: string; userId: string; tenantId?: string | undefi...Runtime schema for Execution Cache Record.
executionCacheResultMetadataJsonSchemaconstantconst executionCacheResultMetadataJsonSchema: JsonSchemaJSON Schema for Execution Cache Result Metadata.
executionCacheResultMetadataSchemaconstantconst executionCacheResultMetadataSchema: z.ZodEffects<z.ZodObject<{ executionId: z.ZodString; status: z.ZodEnum<["queued", "starting", "running", "cancelling", "cancelled", "completed", "failed", "timed_out", "oom_killed", "resource_exceeded", "quarantined"]>; exitCode: z.ZodNullable<z.ZodNumber>; signal: z.ZodOptional<z.ZodString>; resourceUsage: z.ZodOptional<z.ZodObject<{ cpuTimeMs: z.ZodOptional<z.ZodNumber>;...Runtime schema for Execution Cache Result Metadata.
executionCacheScopeJsonSchemaconstantconst executionCacheScopeJsonSchema: JsonSchemaJSON Schema for Execution Cache Scope.
executionCacheScopeSchemaconstantconst executionCacheScopeSchema: z.ZodObject<{ tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodString; workspaceId: z.ZodString; }, "strict", z.ZodTypeAny, { workspaceId: string; userId: string; tenantId?: string | undefined; }, { workspaceId: string; userId: string; tenantId?: string | undefined; }>Runtime schema for Execution Cache Scope.
executionCacheValidityInputExampleconstantconst executionCacheValidityInputExample: ExecutionCacheValidityInputValid example value for Execution Cache Validity Input.
executionCacheValidityInputJsonSchemaconstantconst executionCacheValidityInputJsonSchema: JsonSchemaJSON Schema for Execution Cache Validity Input.
executionCacheValidityInputSchemaconstantconst executionCacheValidityInputSchema: z.ZodObject<{ executable: z.ZodString; argsHash: z.ZodString; sourceTreeHash: z.ZodString; workspaceSnapshotHash: z.ZodOptional<z.ZodString>; environmentHash: z.ZodString; imageDigest: z.ZodOptional<z.ZodString>; dependencyLockHash: z.ZodOptional<z.ZodString>; networkPolicyHash: z.ZodString; secretVersionSetHash: z.ZodOptional<z.ZodString>; commandPolicyRevision: z.ZodOptio...Runtime schema for Execution Cache Validity Input.
executionCommandFingerprintInputExampleconstantconst executionCommandFingerprintInputExample: ExecutionCommandFingerprintInputValid example value for Execution Command Fingerprint Input.
executionCommandFingerprintInputJsonSchemaconstantconst executionCommandFingerprintInputJsonSchema: JsonSchemaJSON Schema for Execution Command Fingerprint Input.
executionCommandFingerprintInputSchemaconstantconst executionCommandFingerprintInputSchema: z.ZodObject<{ executable: z.ZodString; argsHash: z.ZodString; cwd: z.ZodOptional<z.ZodString>; relevantEnvHash: z.ZodString; sourceTreeHash: z.ZodString; environmentHash: z.ZodString; networkPolicyHash: z.ZodString; secretVersionSetHash: z.ZodOptional<z.ZodString>; idempotencyKey: z.ZodString; }, "strict", z.ZodTypeAny, { idempotencyKey: string; sourceTreeHash: string;...Runtime schema for Execution Command Fingerprint Input.
executionEnvironmentFingerprintExampleconstantconst executionEnvironmentFingerprintExample: ExecutionEnvironmentFingerprintValid example value for Execution Environment Fingerprint.
executionEnvironmentFingerprintJsonSchemaconstantconst executionEnvironmentFingerprintJsonSchema: JsonSchemaJSON Schema for Execution Environment Fingerprint.
executionEnvironmentFingerprintResolutionJsonSchemaconstantconst executionEnvironmentFingerprintResolutionJsonSchema: JsonSchemaJSON Schema for Execution Environment Fingerprint Resolution.
executionEnvironmentFingerprintResolutionSchemaconstantconst executionEnvironmentFingerprintResolutionSchema: z.ZodDiscriminatedUnion<"status", [z.ZodObject<{ status: z.ZodLiteral<"resolved">; fingerprint: z.ZodEffects<z.ZodObject<{ environmentRef: z.ZodObject<{ id: z.ZodString; version: z.ZodOptional<z.ZodString>; revision: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { id: string; version?: string | undefined; revision?: string | undefined; }, { id: string;...Runtime schema for Execution Environment Fingerprint Resolution.
executionEnvironmentFingerprintSchemaconstantconst executionEnvironmentFingerprintSchema: z.ZodEffects<z.ZodObject<{ environmentRef: z.ZodObject<{ id: z.ZodString; version: z.ZodOptional<z.ZodString>; revision: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { id: string; version?: string | undefined; revision?: string | undefined; }, { id: string; version?: string | undefined; revision?: string | undefined; }>; environmentRevision: z.ZodString; provid...Runtime schema for Execution Environment Fingerprint.
assessExecutionCacheReusefunctionassessExecutionCacheReuse(input: ExecutionCacheReuseAssessmentInput): ExecutionCacheReuseAssessmentAssess Execution Cache Reuse function with 1 public call signature; parameters and return types are listed below.
canonicalizeExecutionFingerprintInputfunctioncanonicalizeExecutionFingerprintInput(input: ExecutionCommandFingerprintInput | ExecutionCacheValidityInput): stringCanonicalize Execution Fingerprint Input function with 1 public call signature; parameters and return types are listed below.
validateExecutionCacheEntryProjectionfunctionvalidateExecutionCacheEntryProjection(input: unknown): ExecutionCacheEntryProjectionValidate Execution Cache Entry Projection function with 1 public call signature; parameters and return types are listed below.
validateExecutionCacheRecordfunctionvalidateExecutionCacheRecord(input: unknown, maxEntryBytes?: number): ExecutionCacheRecordValidate Execution Cache Record function with 1 public call signature; parameters and return types are listed below.
validateExecutionCacheScopefunctionvalidateExecutionCacheScope(input: unknown): ExecutionCacheScopeValidate Execution Cache Scope function with 1 public call signature; parameters and return types are listed below.
validateExecutionCacheValidityInputfunctionvalidateExecutionCacheValidityInput(input: unknown): ExecutionCacheValidityInputValidate Execution Cache Validity Input function with 1 public call signature; parameters and return types are listed below.
validateExecutionCommandFingerprintInputfunctionvalidateExecutionCommandFingerprintInput(input: unknown): ExecutionCommandFingerprintInputValidate Execution Command Fingerprint Input function with 1 public call signature; parameters and return types are listed below.
validateExecutionEnvironmentFingerprintfunctionvalidateExecutionEnvironmentFingerprint(input: unknown): ExecutionEnvironmentFingerprintValidate Execution Environment Fingerprint function with 1 public call signature; parameters and return types are listed below.
validateExecutionEnvironmentFingerprintResolutionfunctionvalidateExecutionEnvironmentFingerprintResolution(input: unknown): ExecutionEnvironmentFingerprintResolutionValidate Execution Environment Fingerprint Resolution function with 1 public call signature; parameters and return types are listed below.

executionCacheArtifactReferenceJsonSchema

JSON Schema for Execution Cache Artifact Reference.

  • Kind: constant
  • Import: import { executionCacheArtifactReferenceJsonSchema } from '@codesoul-co/hypha-core';
  • Source module: modules/execution-cache/index

Declaration

text
export declare const executionCacheArtifactReferenceJsonSchema: JsonSchema;

executionCacheArtifactReferenceSchema

Runtime schema for Execution Cache Artifact Reference.

  • Kind: constant
  • Import: import { executionCacheArtifactReferenceSchema } from '@codesoul-co/hypha-core';
  • Source module: modules/execution-cache/index

Declaration

text
export declare const executionCacheArtifactReferenceSchema: z.ZodObject<{ artifactRef: z.ZodString; contentHash: z.ZodString; }, "strict", z.ZodTypeAny, { contentHash: string; artifactRef: string; }, { contentHash: string; artifactRef: string; }>;

executionCacheEntryProjectionExample

Valid example value for Execution Cache Entry Projection.

  • Kind: constant
  • Import: import { executionCacheEntryProjectionExample } from '@codesoul-co/hypha-core';
  • Source module: modules/execution-cache/index

Declaration

text
export declare const executionCacheEntryProjectionExample: ExecutionCacheEntryProjection;

executionCacheEntryProjectionJsonSchema

JSON Schema for Execution Cache Entry Projection.

  • Kind: constant
  • Import: import { executionCacheEntryProjectionJsonSchema } from '@codesoul-co/hypha-core';
  • Source module: modules/execution-cache/index

Declaration

text
export declare const executionCacheEntryProjectionJsonSchema: JsonSchema;

executionCacheEntryProjectionSchema

Runtime schema for Execution Cache Entry Projection.

Declaration

text
// Exact type resolved from the package entrypoint; see source for the compiler expansion.
export declare const executionCacheEntryProjectionSchema: (typeof import('@codesoul-co/hypha-core'))['executionCacheEntryProjectionSchema'];

This compiler-expanded constant type is compacted. Its public name, top-level type, and source location remain here; use the module’s exported interfaces, types, or runtime schema for input/output fields.

executionCacheJsonSchemas

Execution Cache JSON Schemas constant exported by the modules/execution-cache/index module.

Declaration

text
export declare const executionCacheJsonSchemas: Record<string, JsonSchema>;

executionCacheRecordJsonSchema

JSON Schema for Execution Cache Record.

Declaration

text
export declare const executionCacheRecordJsonSchema: JsonSchema;

executionCacheRecordSchema

Runtime schema for Execution Cache Record.

Declaration

text
// Exact type resolved from the package entrypoint; see source for the compiler expansion.
export declare const executionCacheRecordSchema: (typeof import('@codesoul-co/hypha-core'))['executionCacheRecordSchema'];

This compiler-expanded constant type is compacted. Its public name, top-level type, and source location remain here; use the module’s exported interfaces, types, or runtime schema for input/output fields.

executionCacheResultMetadataJsonSchema

JSON Schema for Execution Cache Result Metadata.

  • Kind: constant
  • Import: import { executionCacheResultMetadataJsonSchema } from '@codesoul-co/hypha-core';
  • Source module: modules/execution-cache/index

Declaration

text
export declare const executionCacheResultMetadataJsonSchema: JsonSchema;

executionCacheResultMetadataSchema

Runtime schema for Execution Cache Result Metadata.

Declaration

text
// Exact type resolved from the package entrypoint; see source for the compiler expansion.
export declare const executionCacheResultMetadataSchema: (typeof import('@codesoul-co/hypha-core'))['executionCacheResultMetadataSchema'];

This compiler-expanded constant type is compacted. Its public name, top-level type, and source location remain here; use the module’s exported interfaces, types, or runtime schema for input/output fields.

executionCacheScopeJsonSchema

JSON Schema for Execution Cache Scope.

Declaration

text
export declare const executionCacheScopeJsonSchema: JsonSchema;

executionCacheScopeSchema

Runtime schema for Execution Cache Scope.

Declaration

text
export declare const executionCacheScopeSchema: z.ZodObject<{ tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodString; workspaceId: z.ZodString; }, "strict", z.ZodTypeAny, { workspaceId: string; userId: string; tenantId?: string | undefined; }, { workspaceId: string; userId: string; tenantId?: string | undefined; }>;

executionCacheValidityInputExample

Valid example value for Execution Cache Validity Input.

Declaration

text
export declare const executionCacheValidityInputExample: ExecutionCacheValidityInput;

executionCacheValidityInputJsonSchema

JSON Schema for Execution Cache Validity Input.

  • Kind: constant
  • Import: import { executionCacheValidityInputJsonSchema } from '@codesoul-co/hypha-core';
  • Source module: modules/execution-cache/index

Declaration

text
export declare const executionCacheValidityInputJsonSchema: JsonSchema;

executionCacheValidityInputSchema

Runtime schema for Execution Cache Validity Input.

Declaration

text
export declare const executionCacheValidityInputSchema: z.ZodObject<{ executable: z.ZodString; argsHash: z.ZodString; sourceTreeHash: z.ZodString; workspaceSnapshotHash: z.ZodOptional<z.ZodString>; environmentHash: z.ZodString; imageDigest: z.ZodOptional<z.ZodString>; dependencyLockHash: z.ZodOptional<z.ZodString>; networkPolicyHash: z.ZodString; secretVersionSetHash: z.ZodOptional<z.ZodString>; commandPolicyRevision: z.ZodOptional<z.ZodString>; }, "strict", z.ZodTypeAny, { sourceTreeHash: string; networkPolicyHash: string; executable: string; argsHash: string; environmentHash: string; workspaceSnapshotHash?: string | undefined; imageDigest?: string | undefined; dependencyLockHash?: string | undefined; secretVersionSetHash?: string | undefined; commandPolicyRevision?: string | undefined; }, { sourceTreeHash: string; networkPolicyHash: string; executable: string; argsHash: string; environmentHash: string; workspaceSnapshotHash?: string | undefined; imageDigest?: string | undefined; dependencyLockHash?: string | undefined; secretVersionSetHash?: string | undefined; commandPolicyRevision?: string | undefined; }>;

executionCommandFingerprintInputExample

Valid example value for Execution Command Fingerprint Input.

  • Kind: constant
  • Import: import { executionCommandFingerprintInputExample } from '@codesoul-co/hypha-core';
  • Source module: modules/execution-cache/index

Declaration

text
export declare const executionCommandFingerprintInputExample: ExecutionCommandFingerprintInput;

executionCommandFingerprintInputJsonSchema

JSON Schema for Execution Command Fingerprint Input.

  • Kind: constant
  • Import: import { executionCommandFingerprintInputJsonSchema } from '@codesoul-co/hypha-core';
  • Source module: modules/execution-cache/index

Declaration

text
export declare const executionCommandFingerprintInputJsonSchema: JsonSchema;

executionCommandFingerprintInputSchema

Runtime schema for Execution Command Fingerprint Input.

  • Kind: constant
  • Import: import { executionCommandFingerprintInputSchema } from '@codesoul-co/hypha-core';
  • Source module: modules/execution-cache/index

Declaration

text
export declare const executionCommandFingerprintInputSchema: z.ZodObject<{ executable: z.ZodString; argsHash: z.ZodString; cwd: z.ZodOptional<z.ZodString>; relevantEnvHash: z.ZodString; sourceTreeHash: z.ZodString; environmentHash: z.ZodString; networkPolicyHash: z.ZodString; secretVersionSetHash: z.ZodOptional<z.ZodString>; idempotencyKey: z.ZodString; }, "strict", z.ZodTypeAny, { idempotencyKey: string; sourceTreeHash: string; networkPolicyHash: string; executable: string; argsHash: string; environmentHash: string; relevantEnvHash: string; cwd?: string | undefined; secretVersionSetHash?: string | undefined; }, { idempotencyKey: string; sourceTreeHash: string; networkPolicyHash: string; executable: string; argsHash: string; environmentHash: string; relevantEnvHash: string; cwd?: string | undefined; secretVersionSetHash?: string | undefined; }>;

executionEnvironmentFingerprintExample

Valid example value for Execution Environment Fingerprint.

  • Kind: constant
  • Import: import { executionEnvironmentFingerprintExample } from '@codesoul-co/hypha-core';
  • Source module: modules/execution-cache/index

Declaration

text
export declare const executionEnvironmentFingerprintExample: ExecutionEnvironmentFingerprint;

executionEnvironmentFingerprintJsonSchema

JSON Schema for Execution Environment Fingerprint.

  • Kind: constant
  • Import: import { executionEnvironmentFingerprintJsonSchema } from '@codesoul-co/hypha-core';
  • Source module: modules/execution-cache/index

Declaration

text
export declare const executionEnvironmentFingerprintJsonSchema: JsonSchema;

executionEnvironmentFingerprintResolutionJsonSchema

JSON Schema for Execution Environment Fingerprint Resolution.

  • Kind: constant
  • Import: import { executionEnvironmentFingerprintResolutionJsonSchema } from '@codesoul-co/hypha-core';
  • Source module: modules/execution-cache/index

Declaration

text
export declare const executionEnvironmentFingerprintResolutionJsonSchema: JsonSchema;

executionEnvironmentFingerprintResolutionSchema

Runtime schema for Execution Environment Fingerprint Resolution.

  • Kind: constant
  • Import: import { executionEnvironmentFingerprintResolutionSchema } from '@codesoul-co/hypha-core';
  • Source module: modules/execution-cache/index

Declaration

text
// Exact type resolved from the package entrypoint; see source for the compiler expansion.
export declare const executionEnvironmentFingerprintResolutionSchema: (typeof import('@codesoul-co/hypha-core'))['executionEnvironmentFingerprintResolutionSchema'];

This compiler-expanded constant type is compacted. Its public name, top-level type, and source location remain here; use the module’s exported interfaces, types, or runtime schema for input/output fields.

executionEnvironmentFingerprintSchema

Runtime schema for Execution Environment Fingerprint.

  • Kind: constant
  • Import: import { executionEnvironmentFingerprintSchema } from '@codesoul-co/hypha-core';
  • Source module: modules/execution-cache/index

Declaration

text
export declare const executionEnvironmentFingerprintSchema: z.ZodEffects<z.ZodObject<{ environmentRef: z.ZodObject<{ id: z.ZodString; version: z.ZodOptional<z.ZodString>; revision: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { id: string; version?: string | undefined; revision?: string | undefined; }, { id: string; version?: string | undefined; revision?: string | undefined; }>; environmentRevision: z.ZodString; providerId: z.ZodString; imageDigest: z.ZodOptional<z.ZodString>; platform: z.ZodOptional<z.ZodString>; executableVersions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>; dependencyLockHash: z.ZodOptional<z.ZodString>; resourcePolicyHash: z.ZodString; networkPolicyHash: z.ZodString; mountPolicyHash: z.ZodString; secretVersionSetHash: z.ZodOptional<z.ZodString>; fingerprintHash: z.ZodString; }, "strict", z.ZodTypeAny, { environmentRevision: string; providerId: string; networkPolicyHash: string; environmentRef: { id: string; version?: string | undefined; revision?: string | undefined; }; mountPolicyHash: string; resourcePolicyHash: string; fingerprintHash: string; platform?: string | undefined; imageDigest?: string | undefined; dependencyLockHash?: string | undefined; secretVersionSetHash?: string | undefined; executableVersions?: Record<string, string> | undefined; }, { environmentRevision: string; providerId: string; networkPolicyHash: string; environmentRef: { id: string; version?: string | undefined; revision?: string | undefined; }; mountPolicyHash: string; resourcePolicyHash: string; fingerprintHash: string; platform?: string | undefined; imageDigest?: string | undefined; dependencyLockHash?: string | undefined; secretVersionSetHash?: string | undefined; executableVersions?: Record<string, string> | undefined; }>, { environmentRevision: string; providerId: string; networkPolicyHash: string; environmentRef: { id: string; version?: string | undefined; revision?: string | undefined; }; mountPolicyHash: string; resourcePolicyHash: string; fingerprintHash: string; platform?: string | undefined; imageDigest?: string | undefined; dependencyLockHash?: string | undefined; secretVersionSetHash?: string | undefined; executableVersions?: Record<string, string> | undefined; }, { environmentRevision: string; providerId: string; networkPolicyHash: string; environmentRef: { id: string; version?: string | undefined; revision?: string | undefined; }; mountPolicyHash: string; resourcePolicyHash: string; fingerprintHash: string; platform?: string | undefined; imageDigest?: string | undefined; dependencyLockHash?: string | undefined; secretVersionSetHash?: string | undefined; executableVersions?: Record<string, string> | undefined; }>;

assessExecutionCacheReuse

Assess Execution Cache Reuse function with 1 public call signature; parameters and return types are listed below.

Declaration

text
export declare function assessExecutionCacheReuse(input: ExecutionCacheReuseAssessmentInput): ExecutionCacheReuseAssessment;

Call signature

text
assessExecutionCacheReuse(input: ExecutionCacheReuseAssessmentInput): ExecutionCacheReuseAssessment

Parameters

ParameterTypeRequiredDescription
inputExecutionCacheReuseAssessmentInputYesRequired parameter; accepted values are defined by the type column.

Returns

  • Type: ExecutionCacheReuseAssessment
  • Description: The return contract is defined by the type shown above.

canonicalizeExecutionFingerprintInput

Canonicalize Execution Fingerprint Input function with 1 public call signature; parameters and return types are listed below.

  • Kind: function
  • Import: import { canonicalizeExecutionFingerprintInput } from '@codesoul-co/hypha-core';
  • Source module: modules/execution-cache/index

Declaration

text
export declare function canonicalizeExecutionFingerprintInput(input: ExecutionCommandFingerprintInput | ExecutionCacheValidityInput): string;

Call signature

text
canonicalizeExecutionFingerprintInput(input: ExecutionCommandFingerprintInput | ExecutionCacheValidityInput): string

Parameters

ParameterTypeRequiredDescription
inputExecutionCacheValidityInput | ExecutionCommandFingerprintInputYesRequired parameter; accepted values are defined by the type column.

Returns

  • Type: string
  • Description: The return contract is defined by the type shown above.

validateExecutionCacheEntryProjection

Validate Execution Cache Entry Projection function with 1 public call signature; parameters and return types are listed below.

  • Kind: function
  • Import: import { validateExecutionCacheEntryProjection } from '@codesoul-co/hypha-core';
  • Source module: modules/execution-cache/index

Declaration

text
export declare function validateExecutionCacheEntryProjection(input: unknown): ExecutionCacheEntryProjection;

Call signature

text
validateExecutionCacheEntryProjection(input: unknown): ExecutionCacheEntryProjection

Parameters

ParameterTypeRequiredDescription
inputunknownYesRequired parameter; accepted values are defined by the type column.

Returns

  • Type: ExecutionCacheEntryProjection
  • Description: The return contract is defined by the type shown above.

validateExecutionCacheRecord

Validate Execution Cache Record function with 1 public call signature; parameters and return types are listed below.

Declaration

text
export declare function validateExecutionCacheRecord(input: unknown, maxEntryBytes?: number): ExecutionCacheRecord;

Call signature

text
validateExecutionCacheRecord(input: unknown, maxEntryBytes?: number): ExecutionCacheRecord

Parameters

ParameterTypeRequiredDescription
inputunknownYesRequired parameter; accepted values are defined by the type column.
maxEntryBytesnumberNoOptional parameter; accepted values are defined by the type column.

Returns

  • Type: ExecutionCacheRecord
  • Description: The return contract is defined by the type shown above.

validateExecutionCacheScope

Validate Execution Cache Scope function with 1 public call signature; parameters and return types are listed below.

Declaration

text
export declare function validateExecutionCacheScope(input: unknown): ExecutionCacheScope;

Call signature

text
validateExecutionCacheScope(input: unknown): ExecutionCacheScope

Parameters

ParameterTypeRequiredDescription
inputunknownYesRequired parameter; accepted values are defined by the type column.

Returns

  • Type: ExecutionCacheScope
  • Description: The return contract is defined by the type shown above.

validateExecutionCacheValidityInput

Validate Execution Cache Validity Input function with 1 public call signature; parameters and return types are listed below.

Declaration

text
export declare function validateExecutionCacheValidityInput(input: unknown): ExecutionCacheValidityInput;

Call signature

text
validateExecutionCacheValidityInput(input: unknown): ExecutionCacheValidityInput

Parameters

ParameterTypeRequiredDescription
inputunknownYesRequired parameter; accepted values are defined by the type column.

Returns

  • Type: ExecutionCacheValidityInput
  • Description: The return contract is defined by the type shown above.

validateExecutionCommandFingerprintInput

Validate Execution Command Fingerprint Input function with 1 public call signature; parameters and return types are listed below.

  • Kind: function
  • Import: import { validateExecutionCommandFingerprintInput } from '@codesoul-co/hypha-core';
  • Source module: modules/execution-cache/index

Declaration

text
export declare function validateExecutionCommandFingerprintInput(input: unknown): ExecutionCommandFingerprintInput;

Call signature

text
validateExecutionCommandFingerprintInput(input: unknown): ExecutionCommandFingerprintInput

Parameters

ParameterTypeRequiredDescription
inputunknownYesRequired parameter; accepted values are defined by the type column.

Returns

  • Type: ExecutionCommandFingerprintInput
  • Description: The return contract is defined by the type shown above.

validateExecutionEnvironmentFingerprint

Validate Execution Environment Fingerprint function with 1 public call signature; parameters and return types are listed below.

  • Kind: function
  • Import: import { validateExecutionEnvironmentFingerprint } from '@codesoul-co/hypha-core';
  • Source module: modules/execution-cache/index

Declaration

text
export declare function validateExecutionEnvironmentFingerprint(input: unknown): ExecutionEnvironmentFingerprint;

Call signature

text
validateExecutionEnvironmentFingerprint(input: unknown): ExecutionEnvironmentFingerprint

Parameters

ParameterTypeRequiredDescription
inputunknownYesRequired parameter; accepted values are defined by the type column.

Returns

  • Type: ExecutionEnvironmentFingerprint
  • Description: The return contract is defined by the type shown above.

validateExecutionEnvironmentFingerprintResolution

Validate Execution Environment Fingerprint Resolution function with 1 public call signature; parameters and return types are listed below.

  • Kind: function
  • Import: import { validateExecutionEnvironmentFingerprintResolution } from '@codesoul-co/hypha-core';
  • Source module: modules/execution-cache/index

Declaration

text
export declare function validateExecutionEnvironmentFingerprintResolution(input: unknown): ExecutionEnvironmentFingerprintResolution;

Call signature

text
validateExecutionEnvironmentFingerprintResolution(input: unknown): ExecutionEnvironmentFingerprintResolution

Parameters

ParameterTypeRequiredDescription
inputunknownYesRequired parameter; accepted values are defined by the type column.

Returns

  • Type: ExecutionEnvironmentFingerprintResolution
  • Description: The return contract is defined by the type shown above.