Method getReadableMap

src/core/HatTokenMap.ts:84–119

* Returns a transient, read-only hat map for use during the course of a * single command. * * Please do not hold onto this copy beyond the lifetime of a single command, * because it will get stale. * @param usePrePhraseSnapshot Whether to use pre-phrase snapshot * @returns A readab

(usePrePhraseSnapshot: boolean)

   * @returns A readable snapshot of the map
   */
  async getReadableMap(usePrePhraseSnapshot: boolean): Promise<ReadOnlyHatMap> {
    // NB: Take a snapshot before we return the map if it is the beginning of
    // the phrase so all commands will get the same map over the course of the
    // phrase
    await this.maybeTakePrePhraseSnapshot();

    if (usePrePhraseSnapshot) {
      if (this.lastSignalVersion == null) {
        console.error(
          "Pre phrase snapshot requested but no signal was present; please upgrade command client"
        );
        return this.activeMap;
      }

      if (this.prePhraseMapSnapshot == null) {
        console.error(
          "Navigation map pre-phrase snapshot requested, but no snapshot has been taken"
        );
        return this.activeMap;
      }

      if (
        abs(hrtime.bigint() - this.prePhraseMapsSnapshotTimestamp!) >
        PRE_PHRASE_SNAPSHOT_MAX_AGE_NS
      ) {
        console.error(
          "Navigation map pre-phrase snapshot requested, but snapshot is more than a minute old"
        );
        return this.activeMap;
      }

      return this.prePhraseMapSnapshot;
    }

    return this.activeMap;
  }

  public dispose() {
    this.activeMap.dispose();