Class Undetermini

Hierarchy

Undetermini

Index

Constructors

constructor

new Undetermini(runResultRepository: RunResultRepository): Undetermini
Parameters
- runResultRepository: RunResultRepository
Returns Undetermini
- Defined in undetermini.ts:35

Properties

`Private` runResultRepository

runResultRepository: RunResultRepository

Methods

`Private` computeMetrics

computeMetrics(resResults: (RunResult & {
    accuracy: number;
    retrieveFromCache: boolean;
})[]): {
    averageAccuracy: number;
    averageCost: number;
    averageError: number;
    averageLatency: number;
    callFromCacheCount: number;
    realCallCount: number;
    resultsCurrentPrice: number;
    resultsFullPrice: number;
}
Parameters
- resResults: (RunResult & {
  accuracy: number;
  retrieveFromCache: boolean;
  })[]
Returns {
    averageAccuracy: number;
    averageCost: number;
    averageError: number;
    averageLatency: number;
    callFromCacheCount: number;
    realCallCount: number;
    resultsCurrentPrice: number;
    resultsFullPrice: number;
}
- averageAccuracy: number
- averageCost: number
- averageError: number
- averageLatency: number
- callFromCacheCount: number
- realCallCount: number
- resultsCurrentPrice: number
- resultsFullPrice: number
- Defined in undetermini.ts:37

`Private` evaluateAccuracyDefault

evaluateAccuracyDefault(expectedOutput: any, output: any): number
Parameters
- expectedOutput: any
- output: any
Returns number
- Defined in undetermini.ts:100

`Private` getEnoughImplementationResults

getEnoughImplementationResults(payload: {
    implementation: UsecaseImplementation;
    times?: number;
    useCache: boolean;
    useCaseInput: unknown;
}): Promise<{}>
Parameters
- payload: {
      implementation: UsecaseImplementation;
      times?: number;
      useCache: boolean;
      useCaseInput: unknown;
  }
  - implementation: UsecaseImplementation
  - Optional times?: number
  - useCache: boolean
  - useCaseInput: unknown
Returns Promise<{}>
- Defined in undetermini.ts:161

run

run(payload: {
    evaluateAccuracy?: ((output: any) => number);
    expectedUseCaseOutput?: unknown;
    implementations: UsecaseImplementation[];
    presenter?: {
        isActive: boolean;
        options?: {
            hideColumns?: HideableColumn[];
            sortPriority?: SortableColumn[];
        };
    };
    times?: number;
    useCache?: boolean;
    useCaseInput: any;
}): Promise<{
    averageAccuracy: number;
    averageCost: number;
    averageError: number;
    averageLatency: number;
    callFromCacheCount: number;
    name: string;
    realCallCount: number;
    resultsCurrentPrice: number;
    resultsFullPrice: number;
}[]>
Parameters
- payload: {
      evaluateAccuracy?: ((output: any) => number);
      expectedUseCaseOutput?: unknown;
      implementations: UsecaseImplementation[];
      presenter?: {
          isActive: boolean;
          options?: {
              hideColumns?: HideableColumn[];
              sortPriority?: SortableColumn[];
          };
      };
      times?: number;
      useCache?: boolean;
      useCaseInput: any;
  }
  - Optional evaluateAccuracy?: ((output: any) => number)
    - (output: any): number
      
      Parameters
      
      output: any
      
      Returns number
  - Optional expectedUseCaseOutput?: unknown
  - implementations: UsecaseImplementation[]
  - Optional presenter?: {
        isActive: boolean;
        options?: {
            hideColumns?: HideableColumn[];
            sortPriority?: SortableColumn[];
        };
    }
    - isActive: boolean
    - Optional options?: {
      hideColumns?: HideableColumn[];
      sortPriority?: SortableColumn[];
      }
      
      Optional hideColumns?: HideableColumn[]
      
      Optional sortPriority?: SortableColumn[]
  - Optional times?: number
  - Optional useCache?: boolean
  - useCaseInput: any
Returns Promise<{
    averageAccuracy: number;
    averageCost: number;
    averageError: number;
    averageLatency: number;
    callFromCacheCount: number;
    name: string;
    realCallCount: number;
    resultsCurrentPrice: number;
    resultsFullPrice: number;
}[]>
- Defined in undetermini.ts:212

`Private` runImplementation

runImplementation(payload: {
implementation: UsecaseImplementation;
useCaseInput: unknown;
}): Promise<void>
Parameters
- payload: {
  implementation: UsecaseImplementation;
  useCaseInput: unknown;
  }
  - implementation: UsecaseImplementation
  - useCaseInput: unknown
Returns Promise<void>
- Defined in undetermini.ts:127

`Static` create

create(options?: {
filename?: string;
persistOnDisk?: boolean;
}): Promise<Undetermini>
Parameters
- Optional options: {
  filename?: string;
  persistOnDisk?: boolean;
  }
  - Optional filename?: string
  - Optional persistOnDisk?: boolean
Returns Promise<Undetermini>
- Defined in undetermini.ts:23

Class Undetermini

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

runResultRepository: RunResultRepository

Returns Undetermini

Properties

Private runResultRepository

Methods

Private computeMetrics

Parameters

resResults: (RunResult & { accuracy: number; retrieveFromCache: boolean; })[]

Returns { averageAccuracy: number; averageCost: number; averageError: number; averageLatency: number; callFromCacheCount: number; realCallCount: number; resultsCurrentPrice: number; resultsFullPrice: number; }

averageAccuracy: number

averageCost: number

averageError: number

averageLatency: number

callFromCacheCount: number

realCallCount: number

resultsCurrentPrice: number

resultsFullPrice: number

Private evaluateAccuracyDefault

Parameters

expectedOutput: any

output: any

Returns number

Private getEnoughImplementationResults

Parameters

payload: { implementation: UsecaseImplementation; times?: number; useCache: boolean; useCaseInput: unknown; }

implementation: UsecaseImplementation

Optional times?: number

useCache: boolean

useCaseInput: unknown

Returns Promise<{}>

run

Parameters

Optional evaluateAccuracy?: ((output: any) => number)

Parameters

output: any

Returns number

Optional expectedUseCaseOutput?: unknown

implementations: UsecaseImplementation[]

Optional presenter?: { isActive: boolean; options?: { hideColumns?: HideableColumn[]; sortPriority?: SortableColumn[]; }; }

isActive: boolean

Optional options?: { hideColumns?: HideableColumn[]; sortPriority?: SortableColumn[]; }

Optional hideColumns?: HideableColumn[]

Optional sortPriority?: SortableColumn[]

Optional times?: number

Optional useCache?: boolean

useCaseInput: any

Returns Promise<{ averageAccuracy: number; averageCost: number; averageError: number; averageLatency: number; callFromCacheCount: number; name: string; realCallCount: number; resultsCurrentPrice: number; resultsFullPrice: number; }[]>

Private runImplementation

Parameters

payload: { implementation: UsecaseImplementation; useCaseInput: unknown; }

implementation: UsecaseImplementation

useCaseInput: unknown

Returns Promise<void>

Static create

Parameters

Optional options: { filename?: string; persistOnDisk?: boolean; }

Optional filename?: string

Optional persistOnDisk?: boolean

Returns Promise<Undetermini>

Settings

Member Visibility

Theme

`Private` runResultRepository

`Private` computeMetrics

resResults: (RunResult & {
accuracy: number;
retrieveFromCache: boolean;
})[]

Returns {
averageAccuracy: number;
averageCost: number;
averageError: number;
averageLatency: number;
callFromCacheCount: number;
realCallCount: number;
resultsCurrentPrice: number;
resultsFullPrice: number;
}

`Private` evaluateAccuracyDefault

`Private` getEnoughImplementationResults

payload: {
implementation: UsecaseImplementation;
times?: number;
useCache: boolean;
useCaseInput: unknown;
}

`Optional` times?: number

`Optional` evaluateAccuracy?: ((output: any) => number)

`Optional` expectedUseCaseOutput?: unknown

`Optional` presenter?: {
isActive: boolean;
options?: {
hideColumns?: HideableColumn[];
sortPriority?: SortableColumn[];
};
}

`Optional` options?: {
hideColumns?: HideableColumn[];
sortPriority?: SortableColumn[];
}

`Optional` hideColumns?: HideableColumn[]

`Optional` sortPriority?: SortableColumn[]

`Optional` times?: number

`Optional` useCache?: boolean

Returns Promise<{
averageAccuracy: number;
averageCost: number;
averageError: number;
averageLatency: number;
callFromCacheCount: number;
name: string;
realCallCount: number;
resultsCurrentPrice: number;
resultsFullPrice: number;
}[]>

`Private` runImplementation

payload: {
implementation: UsecaseImplementation;
useCaseInput: unknown;
}

`Static` create

`Optional` options: {
filename?: string;
persistOnDisk?: boolean;
}

`Optional` filename?: string

`Optional` persistOnDisk?: boolean