Skip to content

Commit d2f2cb5

Browse files
mikecatcre8
andauthored
doc: Update documents to match with current code (#279)
Signed-off-by: MikeCAT <[email protected]> Co-authored-by: Mirko Mollik <[email protected]>
1 parent 0fc9fb6 commit d2f2cb5

File tree

3 files changed

+16
-9
lines changed

3 files changed

+16
-9
lines changed

docs/0.x/issue.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
## Overview
22

33
```ts
4-
const encodedSdjwt = await sdjwt.issue(claims, disclosureFrame, options);
4+
const encodedSdjwt = await sdjwt.issue(payload, disclosureFrame, options);
55
```
66

77
## Parameters
88

9-
- claims: the payload of SD JWT [Object]
9+
- payload: the payload of SD JWT [Object]
1010
- disclosureFrame: to define which properties should be selectively diclosable (optional, if not provided, there is no disclosure)
1111
- options: (optional)
1212

docs/0.x/present.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
11
```ts
2-
const presentedSDJwt = await sdjwt.present(encodedSdjwt, presentationFrame);
2+
const presentedSDJwt = await sdjwt.present(encodedSdjwt, presentationFrame, options);
33
```
44

55
## Parameters
66

77
- encodedSdjwt: encoded SD JWT [string]
88
- presentationFrame: Represent the properties that should be selectively disclosed [object]
9+
- options: (optional)
10+
11+
```ts
12+
options?: {
13+
kb?: KBOptions; // options for Key Binding
14+
},
15+
```
916

1017
### PresentationFrame
1118

docs/0.x/sdjwt-instance.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,12 @@ type SDJWTConfig = {
5555

5656
## Methods
5757

58-
- issue(claims, privateKey[, disclosureFrame, options])
59-
- present(encodedSDJwt[, presentationKeys])
60-
- validate(encodedSDJwt, publicKey)
61-
- verify(encodedSDJwt, publicKey[, requiredClaimKeys, options])
62-
- config(config)
63-
- encode(sdjwt)
58+
- issue(payload[, disclosureFrame, options])
59+
- present(encodedSDJwt[, presentationFrame, options])
60+
- validate(encodedSDJwt)
61+
- verify(encodedSDJwt[, requiredClaimKeys, requireKeyBindings])
62+
- config(newConfig)
63+
- encode(sdJwt)
6464
- decode(encodedSDJwt)
6565
- keys(encodedSDJwt)
6666
- presentableKeys(encodedSDJwt)

0 commit comments

Comments
 (0)