Installation
npm install --save @types/object-refs
Summary
This package contains type definitions for object-refs (https://github.com/bpmn-io/object-refs).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/object-refs.
index.d.ts
export = Refs;
declare class Refs {
/**
* Creates a new references object defining two inversly related
* attribute descriptors a and b.
* @param {Refs.AttributeDescriptor} a property descriptor
* @param {Refs.AttributeDescriptor} b property descriptor
*/
constructor(a: Refs.AttributeDescriptor, b: Refs.AttributeDescriptor);
/**
* Binds one side of a bi-directional reference to a target object.
* @param {*} target
* @param {string|Refs.AttributeDescriptor} property
*/
bind(target: any, property: string | Refs.AttributeDescriptor): void;
ensureBound(target: any, property: string | Refs.AttributeDescriptor): void;
ensureRefsCollection(target: any, property: Refs.AttributeDescriptor): any;
set(target: any, property: string | Refs.AttributeDescriptor, value: any): void;
unset(target: any, property: string | Refs.AttributeDescriptor, value: any): void;
}
declare namespace Refs {
interface AttributeDescriptor {
name: string;
collection?: boolean | undefined;
enumerable?: boolean | undefined;
}
namespace Collection {
/** Extends a collection with Refs aware methods */
function extend(collection: any[], refs: Refs, property: string | AttributeDescriptor, target: any): any;
function isExtended(collection: any[]): boolean;
}
}
Additional Details
- Last updated: Tue, 07 Nov 2023 09:09:39 GMT
- Dependencies: none
Credits
These definitions were written by Jan Steinbruecker.