Overview

Artifact ID: 9f3ab66ff6fdb61d0ec4ef0922a469a4db0fd5078824dafe83e1eeaff44345cd
Page Name:api
Date: 2018-07-04 14:05:16
Original User: mario
Mimetype:text/x-markdown
Parent: e89c4d57a4a48b9333f963ef59d6d3c9d2f2a0cc3c38f8ae97128fb8dbe48fc5
Content

# api:

An optional field to precise which application a script/plugin belongs to:

# api: streamtuner2

Which is a vanity tag foremost. You wouldn't normally mix scripts from different applications or languages and expect them to behave or work at all.

  • Nonetheless it makes sense for installation management, or filtering in plugin download repositories.

  • Additionally you still want to do some verification, such as

    $meta.api ~= /^(|myapi|altname|python)$/
    
  • Usually you'd allow # api: language for generic plugins (not bound to specific API).

  • And you might very well combine scripts from different APIs (in the same language, that is). For instance if one plugin implemented a stub API:

    # provides: api:archnemesis
    
  • Essentially # api: NAME is a shortcut for # depends: api:NAME. See also depends