docs.json 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156
  1. {
  2. "api": {
  3. "name": "ClipboardPlugin",
  4. "slug": "clipboardplugin",
  5. "docs": "",
  6. "tags": [],
  7. "methods": [
  8. {
  9. "name": "write",
  10. "signature": "(options: WriteOptions) => Promise<void>",
  11. "parameters": [
  12. {
  13. "name": "options",
  14. "docs": "",
  15. "type": "WriteOptions"
  16. }
  17. ],
  18. "returns": "Promise<void>",
  19. "tags": [
  20. {
  21. "name": "since",
  22. "text": "1.0.0"
  23. }
  24. ],
  25. "docs": "Write a value to the clipboard (the \"copy\" action)",
  26. "complexTypes": [
  27. "WriteOptions"
  28. ],
  29. "slug": "write"
  30. },
  31. {
  32. "name": "read",
  33. "signature": "() => Promise<ReadResult>",
  34. "parameters": [],
  35. "returns": "Promise<ReadResult>",
  36. "tags": [
  37. {
  38. "name": "since",
  39. "text": "1.0.0"
  40. }
  41. ],
  42. "docs": "Read a value from the clipboard (the \"paste\" action)",
  43. "complexTypes": [
  44. "ReadResult"
  45. ],
  46. "slug": "read"
  47. }
  48. ],
  49. "properties": []
  50. },
  51. "interfaces": [
  52. {
  53. "name": "WriteOptions",
  54. "slug": "writeoptions",
  55. "docs": "Represents the data to be written to the clipboard.",
  56. "tags": [
  57. {
  58. "text": "1.0.0",
  59. "name": "since"
  60. }
  61. ],
  62. "methods": [],
  63. "properties": [
  64. {
  65. "name": "string",
  66. "tags": [
  67. {
  68. "text": "1.0.0",
  69. "name": "since"
  70. }
  71. ],
  72. "docs": "Text value to copy.",
  73. "complexTypes": [],
  74. "type": "string | undefined"
  75. },
  76. {
  77. "name": "image",
  78. "tags": [
  79. {
  80. "text": "1.0.0",
  81. "name": "since"
  82. }
  83. ],
  84. "docs": "Image in [Data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs) format to copy.",
  85. "complexTypes": [],
  86. "type": "string | undefined"
  87. },
  88. {
  89. "name": "url",
  90. "tags": [
  91. {
  92. "text": "1.0.0",
  93. "name": "since"
  94. }
  95. ],
  96. "docs": "URL string to copy.",
  97. "complexTypes": [],
  98. "type": "string | undefined"
  99. },
  100. {
  101. "name": "label",
  102. "tags": [
  103. {
  104. "text": "1.0.0",
  105. "name": "since"
  106. }
  107. ],
  108. "docs": "User visible label to accompany the copied data (Android Only).",
  109. "complexTypes": [],
  110. "type": "string | undefined"
  111. }
  112. ]
  113. },
  114. {
  115. "name": "ReadResult",
  116. "slug": "readresult",
  117. "docs": "Represents the data read from the clipboard.",
  118. "tags": [
  119. {
  120. "text": "1.0.0",
  121. "name": "since"
  122. }
  123. ],
  124. "methods": [],
  125. "properties": [
  126. {
  127. "name": "value",
  128. "tags": [
  129. {
  130. "text": "1.0.0",
  131. "name": "since"
  132. }
  133. ],
  134. "docs": "Data read from the clipboard.",
  135. "complexTypes": [],
  136. "type": "string"
  137. },
  138. {
  139. "name": "type",
  140. "tags": [
  141. {
  142. "text": "1.0.0",
  143. "name": "since"
  144. }
  145. ],
  146. "docs": "Type of data in the clipboard.",
  147. "complexTypes": [],
  148. "type": "string"
  149. }
  150. ]
  151. }
  152. ],
  153. "enums": [],
  154. "typeAliases": [],
  155. "pluginConfigs": []
  156. }