modules.md

@medialib/medialib / Exports

@medialib/medialib

Table of contents

Namespaces

• arrayUtils
• compareUtils
• objectUtils
• optionUtils
• promiseUtils

Classes

• AbstractAddon
• AbstractAddonManager
• AbstractMedia
• AbstractMediaSource
• AbstractMediaSourceAddon
• AbstractWebSource
• AddonManagerCenter
• AddonMediaSourceManager

Type Aliases

• addonType
• basicAddonDetails
• basicAddonManagerCenterDetails
• basicAddonManagerDetails
• basicAddonResources
• basicAddonSettings
• basicMediaDetails
• diff
• diffType
• mediaSourceAddonDetails
• mediaSourceAddonManagerDetails
• mediaSourceAddonResources
• mediaSourceAddonSettings
• mediaSourceFetchOption
• mediaSourceFetchResult
• mediaSourceSettings
• optionDefinition
• webMediaSourceFetchOption
• webMediaSourceFetchResult
• webMediaSourceSettings

Type Aliases

addonType

Ƭ addonType: "addon" | string & {}

Defined in

node_modules/@addonlib/addonlib/dist/addonTypes.d.ts:15

---

basicAddonDetails

Ƭ basicAddonDetails: { apiVersion: string ; authors: string[] ; dependencies: string[] ; description: string ; id: string ; tags: string[] ; title: string ; type: addonType ; version: string } & Record<string, unknown>

Basic details that every addon is expected to have.

Defined in

node_modules/@addonlib/addonlib/dist/addonTypes.d.ts:4

---

basicAddonManagerCenterDetails

Ƭ basicAddonManagerCenterDetails: {} & Record<string, unknown>

Defined in

node_modules/@addonlib/addonlib/dist/addonManagerCenterTypes.d.ts:1

---

basicAddonManagerDetails

Ƭ basicAddonManagerDetails: { type: addonType } & Record<string, unknown>

Basic details that every addon manager is expected to have.

Param

correspond to the type of addons the manager accept.

Defined in

node_modules/@addonlib/addonlib/dist/addonManagerTypes.d.ts:7

---

basicAddonResources

Ƭ basicAddonResources: {} & Record<string, unknown>

Basic resources that every addon is expected to have.

Defined in

node_modules/@addonlib/addonlib/dist/addonTypes.d.ts:19

---

basicAddonSettings

Ƭ basicAddonSettings: {} & Record<string, unknown>

Basic settings that every addon is expected to have

Defined in

node_modules/@addonlib/addonlib/dist/addonTypes.d.ts:23

---

basicMediaDetails

Ƭ basicMediaDetails: { id: string ; title: string } & Record<string, unknown>

Defined in

src/mediaTypes.ts:1

---

diff

Ƭ diff: Object

Type declaration

Name	Type
__new	any
__old	any

Defined in

src/utils/diffType.ts:1

---

diffType

Ƭ diffType: Object

Index signature

▪ [key: string]: diff | diffType

Defined in

src/utils/diffType.ts:3

---

mediaSourceAddonDetails

Ƭ mediaSourceAddonDetails: { type: "media-source" | string & {} } & basicAddonDetails

Defined in

src/source/mediaSourceAddonTypes.ts:7

---

mediaSourceAddonManagerDetails

Ƭ mediaSourceAddonManagerDetails: {} & basicAddonManagerDetails

Defined in

src/source/mediaSourceAddonManagerTypes.ts:3

---

mediaSourceAddonResources

Ƭ mediaSourceAddonResources: {} & basicAddonResources

Defined in

src/source/mediaSourceAddonTypes.ts:11

---

mediaSourceAddonSettings

Ƭ mediaSourceAddonSettings: {} & basicAddonSettings

Defined in

src/source/mediaSourceAddonTypes.ts:13

---

mediaSourceFetchOption

Ƭ mediaSourceFetchOption: {} & Record<string, unknown>

Defined in

src/source/mediaSourceTypes.ts:5

---

mediaSourceFetchResult

Ƭ mediaSourceFetchResult<T>: { content: T[] } & Record<string, unknown>

Type parameters

Name	Type
T	extends AbstractMedia = AbstractMedia

Defined in

src/source/mediaSourceTypes.ts:7

---

mediaSourceSettings

Ƭ mediaSourceSettings: {} & Record<string, unknown>

Defined in

src/source/mediaSourceTypes.ts:3

---

optionDefinition

Ƭ optionDefinition<T>: { [K in keyof T]: Object }

Give information on options type. (specially useful to on runtime)

Example

type customOption = {
 fieldA: boolean,
 fieldB: string
}

type customOptionDefinition = optionDefinition<customOption>

const customOptionsEx: customOption = {
 fieldA: true,
 fieldB: "abcd"
}

const customOptionsDefinitionEx: customOptionDefinition = {
 fieldA: {
   type: "boolean",
   label: "A field",
   defaultValue: false,
   required: true
 },
 fieldB: {
   type: "string",
   label: "B field",
   defaultValue: "",
   required: false
 },
}

Type parameters

Name	Type
T	extends Record<string, unknown> = Record<string, unknown>

Defined in

node_modules/@addonlib/addonlib/dist/optionTypes.d.ts:34

---

webMediaSourceFetchOption

Ƭ webMediaSourceFetchOption: { limit?: number ; offset?: number } & mediaSourceFetchOption

Defined in

src/source/web/webMediaSourceTypes.ts:13

---

webMediaSourceFetchResult

Ƭ webMediaSourceFetchResult<T>: { limit?: number ; offset?: number ; total?: number } & mediaSourceFetchResult<T>

Type parameters

Name	Type
T	extends AbstractMedia = AbstractMedia

Defined in

src/source/web/webMediaSourceTypes.ts:18

---

webMediaSourceSettings

Ƭ webMediaSourceSettings: { url: string ; userAgent: string } & mediaSourceSettings

Defined in

src/source/web/webMediaSourceTypes.ts:8