@sanity/tsdoc/src/studio/schema/api/members/method.ts

Generate API reference docs from TypeScript projects and store in a Sanity-friendly JSON format. Render a static frontend, or as React components.

import {defineArrayMember, defineField, defineType} from 'sanity'

export const apiMethodType = defineType({
  type: 'object',
  name: 'api.method',
  title: 'Method',
  fields: [
    defineField({
      type: 'string',
      name: 'name',
      title: 'Name',
    }),
    defineField({
      type: 'boolean',
      name: 'isOptional',
      title: 'Is optional',
      options: {layout: 'checkbox'},
    }),
    defineField({
      type: 'boolean',
      name: 'isStatic',
      title: 'Is static',
      options: {layout: 'checkbox'},
    }),
    defineField({
      type: 'api.releaseTag',
      name: 'releaseTag',
      title: 'Release tag',
    }),
    defineField({
      type: 'array',
      name: 'parameters',
      title: 'Parameters',
      of: [defineArrayMember({type: 'api.parameter'})],
    }),
    defineField({
      type: 'api.tokens',
      name: 'returnType',
      title: 'Return type',
    }),
    defineField({
      type: 'array',
      name: 'typeParameters',
      title: 'Type parameters',
      of: [defineArrayMember({type: 'api.typeParameter'})],
    }),
    defineField({
      type: 'tsdoc.docComment',
      name: 'comment',
      title: 'Comment',
    }),
  ],

  preview: {
    select: {title: 'name'},
    prepare: ({title}: any) => ({title, subtitle: 'Method'}),
  },
})