@siren-js/client/dist/visitor/link-finder.js

Siren API client library

import { DefaultSirenElementVisitor } from './default-siren-element-visitor';
/**
 * Collects visited links that satisfy {@linkcode predicate}
 *
 * @example
 * const itemLinkFinder = new LinkFinder((link) => link.rel.includes('item'));
 *
 * await entity.accept(itemLinkFinder);
 *
 * if (!itemLinkFinder.isEmpty) {
 *   const firstItemLink = itemLinkFinder.links[0];
 *   entity = await follow(firstItemLink).then(parse);
 * }
 *
 * // reset the link finder and do it again
 * itemLinkFinder.reset();
 * await entity.accept(itemLinkFinder);
 */
export class LinkFinder extends DefaultSirenElementVisitor {
    predicate;
    _links = [];
    constructor(predicate) {
        super();
        this.predicate = predicate;
    }
    /**
     * Indicates whether any visited links have satisfied {@linkcode predicate}
     */
    get isEmpty() {
        return this.links.length === 0;
    }
    /**
     * List of visited links that have satisfied {@linkcode predicate}
     */
    get links() {
        return Object.freeze(this._links);
    }
    /**
     * Resets this visitor, forgetting all visited links
     */
    reset() {
        this._links = [];
    }
    visitLink(link) {
        if (this.predicate(link))
            this._links.push(link);
    }
}