aboutsummaryrefslogtreecommitdiff
path: root/docs/.vitepress/components/api-docs/method-parameters.vue
blob: ebee96d5ed74d0f50c33882fac9cccd33b90fed8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
<script setup lang="ts">
import type { ApiDocsMethodParameter } from './method';

const { parameters } = defineProps<{ parameters: ApiDocsMethodParameter[] }>();
</script>

<template>
  <div>
    <h3>Parameters</h3>

    <table>
      <thead>
        <tr>
          <th>Name</th>
          <th>Type</th>
          <th>Default</th>
          <th>Description</th>
        </tr>
      </thead>
      <tbody>
        <tr
          v-for="{ name, description, type, default: def } of parameters"
          :key="name"
        >
          <td
            :class="{
              deprecated: description.includes('DEPRECATED'),
            }"
          >
            {{ name }}
          </td>
          <td>{{ type }}</td>
          <td>
            <code v-if="def">{{ def }}</code>
          </td>
          <td v-html="description"></td>
        </tr>
      </tbody>
    </table>
  </div>
</template>

<style scoped>
td.deprecated {
  text-decoration: line-through;
}
</style>