API Reference

IValueMetadatainterface

Service contract used by value metadata implementations to classify runtime values and report async/proxy behavior.

Quick facts

Kind: interface
Module: value-metadata
Members: 4
Package: @rs-x/core
Source: value-metadata/value-metadata.interface.ts

Declaration

export interface IValueMetadata {
  readonly priority: number;
  isAsync(value: unknown): boolean;
  needsProxy(value: unknown): boolean;
  applies(value: unknown): boolean;
}

Import

import type { IValueMetadata } from '@rs-x/core';

Members

4 members in this interface.

readonly priority

propertyreadonly

readonly priority: number

Type

number

applies

method

applies(value: unknown): boolean

Parameters

Name	Type	Required
value	unknown	required

Returns

boolean

isAsync

method

isAsync(value: unknown): boolean

Parameters

Name	Type	Required
value	unknown	required

Returns

boolean

needsProxy

method

needsProxy(value: unknown): boolean

Parameters

Name	Type	Required
value	unknown	required

Returns

boolean