Class: MetaManagerImpl
@ima/core.MetaManagerImpl
Default implementation of the MetaManager interface.
Hierarchy
↳
MetaManagerImpl
Constructors
constructor
• new MetaManagerImpl()
Initializes the meta page attributes manager.
Overrides
Defined in
packages/core/src/meta/MetaManagerImpl.ts:24
Properties
_link
• Protected _link: Map<string, MetaManagerRecord<"href">>
Defined in
packages/core/src/meta/MetaManagerImpl.ts:15
_metaName
• Protected _metaName: Map<string, MetaManagerRecord<"content">>
Defined in
packages/core/src/meta/MetaManagerImpl.ts:13
_metaProperty
• Protected _metaProperty: Map<string, MetaManagerRecord<"content">>
Defined in
packages/core/src/meta/MetaManagerImpl.ts:14
_title
• Protected _title: string
Defined in
packages/core/src/meta/MetaManagerImpl.ts:12
Accessors
$dependencies
• Static get $dependencies(): never[]
Returns
never[]
Defined in
packages/core/src/meta/MetaManagerImpl.ts:17
Methods
clearMetaAttributes
▸ clearMetaAttributes(): void
Resets the stored meta names, properties and links.
Returns
void
Overrides
MetaManager.clearMetaAttributes
Defined in
packages/core/src/meta/MetaManagerImpl.ts:166
getLink
▸ getLink(relation): MetaManagerRecord<"href">
Return the reference to the specified related linked document. The method returns an empty string for missing meta information (to make the returned value React-friendly).
Parameters
| Name | Type | Description |
|---|---|---|
relation | string | The relation of the link target to the current page. |
Returns
MetaManagerRecord<"href">
The reference to the location of the related document, e.g. a URL.
Overrides
Defined in
packages/core/src/meta/MetaManagerImpl.ts:145
getLinks
▸ getLinks(): string[]
Returns the relations of the currently set related documents linked to the current page.
Returns
string[]
Overrides
Defined in
packages/core/src/meta/MetaManagerImpl.ts:152
getLinksIterator
▸ getLinksIterator(): IterableIterator<[string, MetaManagerRecord<"href">]>
Return [key, value] pairs of currently set links.
Returns
IterableIterator<[string, MetaManagerRecord<"href">]>
[key, value] pairs of currently set links.
Overrides
Defined in
packages/core/src/meta/MetaManagerImpl.ts:159
getMetaName
▸ getMetaName(name): MetaManagerRecord<"content">
Returns the value of the specified named meta information property. The method returns an empty string for missing meta information (to make the returned value React-friendly).
Parameters
| Name | Type | Description |
|---|---|---|
name | string | The name of the named meta information property. |
Returns
MetaManagerRecord<"content">
The value of the generic meta information, or an empty string.
Overrides
Defined in
packages/core/src/meta/MetaManagerImpl.ts:76
getMetaNames
▸ getMetaNames(): string[]
Returns the names of the currently specified named meta information properties.
Returns
string[]
The names of the currently specified named meta information properties.
Overrides
Defined in
packages/core/src/meta/MetaManagerImpl.ts:83
getMetaNamesIterator
▸ getMetaNamesIterator(): IterableIterator<[string, MetaManagerRecord<"content">]>
Return [key, value] pairs of named meta information.
Returns
IterableIterator<[string, MetaManagerRecord<"content">]>
[key, value] pairs of named meta information.
Overrides
MetaManager.getMetaNamesIterator
Defined in
packages/core/src/meta/MetaManagerImpl.ts:90
getMetaProperties
▸ getMetaProperties(): string[]
Returns the names of the currently specified specialized meta information properties.
Returns
string[]
The names of the currently specified specialized meta information properties.
Overrides
Defined in
packages/core/src/meta/MetaManagerImpl.ts:120
getMetaPropertiesIterator
▸ getMetaPropertiesIterator(): IterableIterator<[string, MetaManagerRecord<"content">]>
Return [key, value] pairs of meta information properties.
Returns
IterableIterator<[string, MetaManagerRecord<"content">]>
[key, value] pairs of meta information properties.
Overrides
MetaManager.getMetaPropertiesIterator
Defined in
packages/core/src/meta/MetaManagerImpl.ts:127
getMetaProperty
▸ getMetaProperty(property): MetaManagerRecord<"content">
Returns the value of the specified specialized meta information property. The method returns an empty string for missing meta information (to make the returned value React-friendly).
Parameters
| Name | Type |
|---|---|
property | string |
Returns
MetaManagerRecord<"content">
The value of the specified meta information, or an empty string.
Overrides
Defined in
packages/core/src/meta/MetaManagerImpl.ts:112
getTitle
▸ getTitle(): string
Returns the page title. The method returns an empty string if no page title has been set yet.
Note that the page title is cached internally by the meta manager and may therefore differ from the current document title if it has been modified by a 3rd party code.
Returns
string
The current page title.
Overrides
Defined in
packages/core/src/meta/MetaManagerImpl.ts:60
setLink
▸ setLink(relation, href, attr?): MetaManagerImpl
Sets the specified specialized link information.
Parram
attr Additional optional link attributes.
Parameters
| Name | Type | Description |
|---|---|---|
relation | string | The relation of the link target to the current page. |
href | MetaValue | The reference to the location of the related document, e.g. a URL. |
attr? | MetaAttributes | - |
Returns
Overrides
Defined in
packages/core/src/meta/MetaManagerImpl.ts:136
setMetaName
▸ setMetaName(name, content, attr?): MetaManagerImpl
Set the specified named meta information property.
Parram
attr Additional optional meta attributes.
Parameters
| Name | Type | Description |
|---|---|---|
name | string | Meta information property name, for example keywords. |
content | MetaValue | The meta information content. |
attr? | MetaAttributes | - |
Returns
Overrides
Defined in
packages/core/src/meta/MetaManagerImpl.ts:67
setMetaProperty
▸ setMetaProperty(property, content, attr?): MetaManagerImpl
Sets the specified specialized meta information property.
Parram
attr Additional optional meta attributes.
Parameters
| Name | Type | Description |
|---|---|---|
property | string | The value of the meta information property. |
content | MetaValue | - |
attr? | MetaAttributes | - |
Returns
Overrides
Defined in
packages/core/src/meta/MetaManagerImpl.ts:99
setTitle
▸ setTitle(title): MetaManagerImpl
Sets the page title.
Parameters
| Name | Type | Description |
|---|---|---|
title | string | The new page title. |