Members
enforcer_ :shaka.deprecate.Enforcer
The global deprecation enforcer that will be set by the player (because the
player knows the version) when it calls |init|. This may appear a little
round-about to you, because it is. Since player uses |Deprecate|, it means
that |Deprecate| can't depend on Player directly.
Type:
- Source:
Methods
deprecateFeature(major, name, description)
Ask the deprecation system to require this feature to be removed by the
given version.
Parameters:
| Name | Type | Description |
|---|---|---|
major |
number | |
name |
string | |
description |
string |
- Source:
init(versionString)
Initialize the system. This must happen before any calls to |enforce|. In
our code base, |shaka.Player| will be the only one to call this (it has the
version string).
If the |Deprecate| called |Player.version| to initialize itself, it would
mean that |Player| could not use |Deprecate| because it would create a
circular dependency. To work around this, we provide this method so that
|Player| can give us the version without us needing to know about |Player|.
This will initialize the system to:
- print warning messages when the feature is scheduled to be removed in a
later version
- print errors and fail assertions when the feature should be removed now
Parameters:
| Name | Type | Description |
|---|---|---|
versionString |
string |
- Source:
onExpired_(libraryVersionnon-null, featureVersionnon-null, name, description)
Parameters:
| Name | Type | Description |
|---|---|---|
libraryVersion |
shaka.deprecate.Version | |
featureVersion |
shaka.deprecate.Version | |
name |
string | |
description |
string |
- Source:
onPending_(libraryVersionnon-null, featureVersionnon-null, name, description)
Parameters:
| Name | Type | Description |
|---|---|---|
libraryVersion |
shaka.deprecate.Version | |
featureVersion |
shaka.deprecate.Version | |
name |
string | |
description |
string |
- Source: