Documentation for 2.0 version #209
Conversation
eliamaino-fp
force-pushed
the
2.0-documentation
branch
4 times, most recently
from
14d10d0 to
9940ee7
Compare
eliamaino-fp
force-pushed
the
2.0-documentation
branch
from
9940ee7 to
4a4782f
Compare
| # VAST Javascript Client | ||
| Vast Client JS is a Javascript library for parsing Digital Video Ad Serving Template (VAST) documents as close as possible to the Interactive Advertising Bureau (IAB) specification. | ||
| # VAST Client JS | ||
| Vast Client JS is a JavaScript library to fetch and parse Digital Video Ad Serving Template (VAST) documents. |
README.md
Outdated
| ## Documentation | ||
| The [client](docs/client.md) documentation contains the basic information to parse a VAST URL/Document. | ||
| ## Get Started | ||
| VAST Client JS is available as a npm package and can be easily installed with: |
There was a problem hiding this comment.
is available as a npm package
should be
is available as an NPM package
README.md
Outdated
|
|
||
| For more advanced use of the parser, see the [parser](docs/parser.md) documentation. | ||
| ### VASTClient | ||
| If you need to fetch and parse one (or multiple) VAST documents you can use the **VASTClient**: |
There was a problem hiding this comment.
If you need to fetch and parse one (or multiple) VAST documents you can use....
can probably just be
If you need to fetch and parse VAST documents, you can use....
README.md
Outdated
| // Do something with the parsed VAST response | ||
| }); | ||
| ``` | ||
| In addition to fetching and parsing a VAST resource, **VASTClient** provides option to filter a sequence of call based on count and time of execution, together with the possibility to track urls using **VASTTracker**. |
There was a problem hiding this comment.
... provides option to filter a sequence of call based on count and time of execution, together with the possibility to track urls using ...
should be
... provides options to filter a sequence of calls based on count and time of execution, together with the possibility to track URLs ...
(or "provides an option" if there's just one)
README.md
Outdated
| Read the [**2.0 migration guide**](docs/api/2.0-migration.md) to update your project or follow the [**1.x API documentation**](docs/api/1.x) if you're still using the old version. | ||
|
|
||
| ## Support and compatibility | ||
| The library is 100% written in JavaScript and the source code uses modern features like `es6 modules`, be sure to use it in an environment which support them or to transpile the library correctly when bundling your project. |
There was a problem hiding this comment.
..., be sure to use it in an environment which support them or to transpile the library correctly when bundling your project.
can probably be
... Make sure your environment supports these features, or transpile the library when bundling your project.
docs/api/2.0-migration.md
Outdated
| ## Changes in Parser API | ||
|
|
||
| ### Constructor and properties | ||
| As mentioned in the first section, now you can use the parser only through an instance. Documentation for the constructor is available in the `VASTParser` API docs. |
There was a problem hiding this comment.
If I understood correctly,
now you can use the parser only through an instance.
should be
you can now only use the parser through an instance
(unless you wanted to say that using the parser through an instance is optional)
docs/api/vast-parser.md
Outdated
|
|
||
| `VASTParser` provides methods to fetch a VAST resource because of his ability to resolving the wrapper chain (recursive fetch and parse). | ||
|
|
||
| Use directly an instance of this class only if you don't need any control on multiple calls, otherwise access it through an instance of `VASTClient`. |
There was a problem hiding this comment.
Use directly an instance of this class
should be
Use an instance of this class directly
docs/api/vast-parser.md
Outdated
| * [Methods](#methods) | ||
|
|
||
| ### Error tracking | ||
| Whenever an error occurs during the VAST parsing, the parser will call on his own all related tracking error URLs. Reported errors are: |
There was a problem hiding this comment.
on his own
did you mean automatically?
docs/api/vast-tracker.md
Outdated
| * **`client: VASTClient`** - An optional instance of VASTClient that can be updated by the tracker. | ||
| * **`ad: Ad`** - The ad to track | ||
| * **`creative: Creative`** - The creative to track | ||
| * **`variation: CompanionAd|NonLinearAd`** - An optional variation of the creative, for Comapnion and NonLinear Ads |
docs/api/vast-tracker.md
Outdated
| ``` | ||
|
|
||
| Here is the list of event emitted by the class: | ||
| * **`complete`** - Only for linear ad with a duration. Emitted after `complete()` has been called. |
There was a problem hiding this comment.
for linear ad
(and the instances below) either
for a linear ad
or
for linear ads
Documentation for 2.0 version