@svta/cml-request 1.0.14 → 1.0.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +17 -0
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -11,5 +11,22 @@ npm i @svta/cml-request
11
11
  ## Usage
12
12
 
13
13
  ```typescript
14
+ import type { CommonMediaRequest, CommonMediaResponse, Requester } from "@svta/cml-request";
14
15
 
16
+ // A requester adapts an HTTP client to the common request and response types.
17
+ const fetchRequester: Requester = async (request: CommonMediaRequest): Promise<CommonMediaResponse> => {
18
+ const response = await fetch(request.url, { method: request.method, headers: request.headers });
19
+ return {
20
+ request,
21
+ url: response.url,
22
+ status: response.status,
23
+ statusText: response.statusText,
24
+ };
25
+ };
26
+
27
+ // Pass fetchRequester to a component that accepts a Requester, and call it with a request like this one.
28
+ const request: CommonMediaRequest = {
29
+ url: "https://example.com/video/segment_001.m4s",
30
+ method: "GET",
31
+ };
15
32
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@svta/cml-request",
3
- "version": "1.0.14",
3
+ "version": "1.0.16",
4
4
  "description": "Common Media Request and Response types",
5
5
  "license": "Apache-2.0",
6
6
  "type": "module",
@@ -50,8 +50,8 @@
50
50
  }
51
51
  },
52
52
  "peerDependencies": {
53
- "@svta/cml-cmcd": "2.4.1",
54
- "@svta/cml-xml": "1.1.5",
55
- "@svta/cml-utils": "1.5.1"
53
+ "@svta/cml-cmcd": "2.6.0",
54
+ "@svta/cml-xml": "1.2.0",
55
+ "@svta/cml-utils": "1.6.0"
56
56
  }
57
57
  }