Class Package

constructor

• new Package(param): Package

• Parameters

  • param: PackageOptions

  Returns Package

deep

name

applyMiniLinks

• applyMiniLinks(): Promise<void>

• Pastes your links into minilinks

  Returns Promise<void>

  Example

  Use applyMiniLinks and idLocal

  const package = new Package({deep});
  await package.applyMiniLinks();
  const deviceLinkId = await package.Device.idLocal();
  Copy

createEntity

• createEntity(name): {
      id: (() => Promise<number>);
      idLocal: (() => number);
      name: string;
  }

• Creates an entity

  Parameters

  • name: string

  Returns {
      id: (() => Promise<number>);
      idLocal: (() => number);
      name: string;
  }

  • id: (() => Promise<number>)

    • • (): Promise<number>

      • Gets id of the link

        Returns Promise<number>

        Example

        Get id of the link

        const myPackage = new MyPackage({deep});
        const myLinkId = await myPackage.yourLinkName.id();
        Copy

  • idLocal: (() => number)

    • • (): number

      • Gets id of the link from minilinks

        Returns number

        Example

        Get id of the link from minilinks

        const myPackage = new MyPackage({deep});
        const myLinkLocalId = await myPackage.yourLinkName.idLocal();
        Copy

  • name: string

    Name of the link

  Example

  Create an entity

  class MyPackage extends Package {
  public yourLinkName = this.createEntity("YourLinkName");
  }
  const myPackage = new MyPackage({deep});
  const myLinkId = await myPackage.yourLinkName.id();
  const myLinkLocalId = await myPackage.yourLinkName.idLocal();
  Copy

id

• id(...names): Promise<number>

• Gets id of the package link

  Parameters

  • Rest ...names: string[]

    Rest

  Returns Promise<number>

  Example

  Get id of the package link

  const package = new Package({deep});
  const myLinkId = await package.id("MyLinkName");
  Copy

idLocal

• idLocal(...names): number

• Gets id of the package link from minilinks

  Parameters

  • Rest ...names: string[]

    Rest

  Returns number

  Example

  Get id of the package link from minilinks

  const package = new Package({deep});
  await package.applyMiniLinks();
  const myLinkId = await package.idLocal("MyLinkName");
  Copy