br41nslug/directus-extension-reference

Unofficial typedoc generated extension services reference

Unofficial Directus v10 Extension Reference

These docs are generated using TypeDoc for an easy reference of the Services exposed to backend extensions by Directus.

Commmonly used

• ItemsService
• FilesService
• MailService

Services

• ActivityService
• AssetsService
• AuthenticationService
• AuthorizationService
• CollectionsService
• DashboardsService
• ExportService
• ExtensionsService
• FieldsService
• FilesService
• FlowsService
• FoldersService
• GraphQLService
• ImportService
• ItemsService
• MailService
• MetaService
• NotificationsService
• OperationsService
• PanelsService
• PayloadService
• PermissionsService
• PresetsService
• RelationsService
• RevisionsService
• RolesService
• SchemaService
• ServerService
• SettingsService
• SharesService
• SpecificationService
• TFAService
• UsersService
• UtilsService
• VersionsService
• WebhooksService
• WebSocketService

How to generate the docs

After checking out the current repository and from it's root run:

• git clone https://github.com/directus/directus directus
• cd directus
• pnpm i
• cd api
• pnpm i typedoc typedoc-plugin-markdown
• npx typedoc --plugin typedoc-plugin-markdown --skipErrorChecking --out ../../reference src/services/index.ts