Skip to content
This repository was archived by the owner on Oct 19, 2023. It is now read-only.

Commit 53b983d

Browse files
committed
include README files in docs
1 parent 5f3fec0 commit 53b983d

30 files changed

+171
-147
lines changed

docs/core/enums/index.State.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
#### Defined in
2222

23-
[src/types/index.ts:416](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L416)
23+
[src/types/index.ts:416](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L416)
2424

2525
___
2626

@@ -30,7 +30,7 @@ ___
3030

3131
#### Defined in
3232

33-
[src/types/index.ts:414](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L414)
33+
[src/types/index.ts:414](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L414)
3434

3535
___
3636

@@ -40,4 +40,4 @@ ___
4040

4141
#### Defined in
4242

43-
[src/types/index.ts:415](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L415)
43+
[src/types/index.ts:415](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L415)

docs/core/interfaces/index.AccountModule.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The new generated token
3838

3939
#### Defined in
4040

41-
[src/types/index.ts:477](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L477)
41+
[src/types/index.ts:477](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L477)
4242

4343
___
4444

@@ -66,7 +66,7 @@ List of assets which was bought by the address given as argument
6666

6767
#### Defined in
6868

69-
[src/types/index.ts:472](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L472)
69+
[src/types/index.ts:472](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L472)
7070

7171
___
7272

@@ -94,7 +94,7 @@ List of assets which was published by the address given
9494

9595
#### Defined in
9696

97-
[src/types/index.ts:466](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L466)
97+
[src/types/index.ts:466](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L466)
9898

9999
___
100100

@@ -125,7 +125,7 @@ true if the user owns at least one edition of the NFT
125125

126126
#### Defined in
127127

128-
[src/types/index.ts:492](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L492)
128+
[src/types/index.ts:492](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L492)
129129

130130
___
131131

@@ -158,7 +158,7 @@ true if the user holds the NFT
158158

159159
#### Defined in
160160

161-
[src/types/index.ts:503](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L503)
161+
[src/types/index.ts:503](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L503)
162162

163163
___
164164

@@ -180,4 +180,4 @@ if token is valid it will return true
180180

181181
#### Defined in
182182

183-
[src/types/index.ts:482](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L482)
183+
[src/types/index.ts:482](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L482)

docs/core/interfaces/index.AssetFile.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ File title
2727

2828
#### Defined in
2929

30-
[src/types/index.ts:725](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L725)
30+
[src/types/index.ts:725](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L725)
3131

3232
___
3333

@@ -39,4 +39,4 @@ File type: json, txt, etc...
3939

4040
#### Defined in
4141

42-
[src/types/index.ts:723](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L723)
42+
[src/types/index.ts:723](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L723)

docs/core/interfaces/index.AssetPublishParams.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Files to download after buy the asset
3232

3333
#### Defined in
3434

35-
[src/types/index.ts:745](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L745)
35+
[src/types/index.ts:745](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L745)
3636

3737
___
3838

@@ -44,7 +44,7 @@ Who create the asset
4444

4545
#### Defined in
4646

47-
[src/types/index.ts:735](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L735)
47+
[src/types/index.ts:735](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L735)
4848

4949
___
5050

@@ -56,7 +56,7 @@ The category that belong the asset
5656

5757
#### Defined in
5858

59-
[src/types/index.ts:741](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L741)
59+
[src/types/index.ts:741](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L741)
6060

6161
___
6262

@@ -68,7 +68,7 @@ Description about what is the utility of the asset
6868

6969
#### Defined in
7070

71-
[src/types/index.ts:737](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L737)
71+
[src/types/index.ts:737](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L737)
7272

7373
___
7474

@@ -80,7 +80,7 @@ Name of the asset
8080

8181
#### Defined in
8282

83-
[src/types/index.ts:733](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L733)
83+
[src/types/index.ts:733](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L733)
8484

8585
___
8686

@@ -92,7 +92,7 @@ Price of the asset
9292

9393
#### Defined in
9494

95-
[src/types/index.ts:743](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L743)
95+
[src/types/index.ts:743](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L743)
9696

9797
___
9898

@@ -104,4 +104,4 @@ The type of the asset
104104

105105
#### Defined in
106106

107-
[src/types/index.ts:739](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L739)
107+
[src/types/index.ts:739](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L739)

docs/core/interfaces/index.AssetPublishProviderState.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Handle publish asset message
4040

4141
#### Defined in
4242

43-
[src/types/index.ts:823](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L823)
43+
[src/types/index.ts:823](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L823)
4444

4545
___
4646

@@ -52,7 +52,7 @@ All the parameters needed to publish an asset
5252

5353
#### Defined in
5454

55-
[src/types/index.ts:829](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L829)
55+
[src/types/index.ts:829](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L829)
5656

5757
___
5858

@@ -64,7 +64,7 @@ Handle error publish asset message
6464

6565
#### Defined in
6666

67-
[src/types/index.ts:821](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L821)
67+
[src/types/index.ts:821](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L821)
6868

6969
___
7070

@@ -91,7 +91,7 @@ Update asset parameters when some input changes
9191

9292
#### Defined in
9393

94-
[src/types/index.ts:840](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L840)
94+
[src/types/index.ts:840](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L840)
9595

9696
___
9797

@@ -103,7 +103,7 @@ If the asset is publishing
103103

104104
#### Defined in
105105

106-
[src/types/index.ts:827](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L827)
106+
[src/types/index.ts:827](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L827)
107107

108108
___
109109

@@ -115,7 +115,7 @@ If the asset was published correctly
115115

116116
#### Defined in
117117

118-
[src/types/index.ts:825](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L825)
118+
[src/types/index.ts:825](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L825)
119119

120120
___
121121

@@ -147,7 +147,7 @@ Asset object
147147

148148
#### Defined in
149149

150-
[src/types/index.ts:871](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L871)
150+
[src/types/index.ts:871](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L871)
151151

152152
___
153153

@@ -177,7 +177,7 @@ Asset object
177177

178178
#### Defined in
179179

180-
[src/types/index.ts:857](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L857)
180+
[src/types/index.ts:857](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L857)
181181

182182
___
183183

@@ -206,7 +206,7 @@ Asset object
206206

207207
#### Defined in
208208

209-
[src/types/index.ts:850](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L850)
209+
[src/types/index.ts:850](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L850)
210210

211211
___
212212

@@ -232,7 +232,7 @@ Reset all the parameters of the asset
232232

233233
#### Defined in
234234

235-
[src/types/index.ts:844](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L844)
235+
[src/types/index.ts:844](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L844)
236236

237237
___
238238

@@ -244,7 +244,7 @@ Set error asset message
244244

245245
#### Defined in
246246

247-
[src/types/index.ts:835](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L835)
247+
[src/types/index.ts:835](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L835)
248248

249249
___
250250

@@ -256,7 +256,7 @@ Set asset message
256256

257257
#### Defined in
258258

259-
[src/types/index.ts:833](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L833)
259+
[src/types/index.ts:833](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L833)
260260

261261
___
262262

@@ -268,4 +268,4 @@ Set parameters needed to publish an asset
268268

269269
#### Defined in
270270

271-
[src/types/index.ts:831](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L831)
271+
[src/types/index.ts:831](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L831)

docs/core/interfaces/index.AssetState.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Asset object
2626

2727
#### Defined in
2828

29-
[src/types/index.ts:669](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L669)
29+
[src/types/index.ts:669](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L669)
3030

3131
___
3232

@@ -38,7 +38,7 @@ Error message from some operation with asset
3838

3939
#### Defined in
4040

41-
[src/types/index.ts:673](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L673)
41+
[src/types/index.ts:673](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L673)
4242

4343
___
4444

@@ -50,7 +50,7 @@ True if asset object is loaded
5050

5151
#### Defined in
5252

53-
[src/types/index.ts:675](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L675)
53+
[src/types/index.ts:675](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L675)
5454

5555
___
5656

@@ -62,7 +62,7 @@ Metada of the asset with the basic information
6262

6363
#### Defined in
6464

65-
[src/types/index.ts:671](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L671)
65+
[src/types/index.ts:671](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L671)
6666

6767
___
6868

@@ -74,4 +74,4 @@ Details of the asset agreement
7474

7575
#### Defined in
7676

77-
[src/types/index.ts:677](https://github.com/nevermined-io/components-catalog/blob/76192a6/lib/src/types/index.ts#L677)
77+
[src/types/index.ts:677](https://github.com/nevermined-io/components-catalog/blob/5f3fec0/lib/src/types/index.ts#L677)

0 commit comments

Comments
 (0)