@codesoul-co/hypha-core / modules/artifact/gc

• Package index: @codesoul-co/hypha-core
• Source: packages/core/src/modules/artifact/gc.ts
• Exports: 2

Using this module

Use the Gc module for using the public contracts and operations for this capability boundary. It exports 1 class, 1 function.

Import from the package entrypoint

import {
  DefaultArtifactGarbageCollector,
  validateArtifactGarbageCollectionRequest,
} from '@codesoul-co/hypha-core';

Usage patterns

• The module exposes 1 class as constructable runtime implementations. Each symbol entry lists its constructor and public methods.
• The module exposes 1 function as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.

Public exports

Symbol	Kind	Signature	Description
DefaultArtifactGarbageCollector	class	new DefaultArtifactGarbageCollector(options: DefaultArtifactGarbageCollectorOptions): DefaultArtifactGarbageCollector	Default Artifact Garbage Collector class with 2 public constructor or member entries; its exact declarations are listed below.
validateArtifactGarbageCollectionRequest	function	validateArtifactGarbageCollectionRequest(request: ArtifactGarbageCollectionRequest): ArtifactGarbageCollectionRequest	Validate Artifact Garbage Collection Request function with 1 public call signature; parameters and return types are listed below.

DefaultArtifactGarbageCollector

Default Artifact Garbage Collector class with 2 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { DefaultArtifactGarbageCollector } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/gc

Declaration

export declare class DefaultArtifactGarbageCollector implements ArtifactGarbageCollector {
    constructor(options: DefaultArtifactGarbageCollectorOptions);
    collect(input: ArtifactGarbageCollectionRequest): Promise<ArtifactGarbageCollectionResult>;
}

Public members

Member	Kind	Signature	Description
collect	method	collect(input: ArtifactGarbageCollectionRequest): Promise<ArtifactGarbageCollectionResult>	Public method; parameters and return type are shown in the signature.
constructor	constructor	(options: DefaultArtifactGarbageCollectorOptions): DefaultArtifactGarbageCollector	Creates an instance of this class.

validateArtifactGarbageCollectionRequest

Validate Artifact Garbage Collection Request function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateArtifactGarbageCollectionRequest } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/gc

Declaration

export declare function validateArtifactGarbageCollectionRequest(request: ArtifactGarbageCollectionRequest): ArtifactGarbageCollectionRequest;

Call signature

validateArtifactGarbageCollectionRequest(request: ArtifactGarbageCollectionRequest): ArtifactGarbageCollectionRequest

Parameters

Parameter	Type	Required	Description
request	ArtifactGarbageCollectionRequest	Yes	Required parameter; accepted values are defined by the type column.

Returns

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