MCPcopy Index your code
hub / github.com/SoftwareBrothers/adminjs / AdminJSOptions

Interface AdminJSOptions

src/adminjs-options.interface.ts:55–249  ·  view source on GitHub ↗

Source from the content-addressed store, hash-verified

53 * ```
54 */
55export interface AdminJSOptions {
56 /**
57 * path, under which, AdminJS will be available. Default to `/admin`
58 *
59 */
60 rootPath?: string;
61 /**
62 * url to a logout action, default to `/admin/logout`
63 */
64 logoutPath?: string;
65 /**
66 * url to a login page, default to `/admin/login`
67 */
68 loginPath?: string;
69 /**
70 * Array of all Databases which are supported by AdminJS via adapters
71 */
72 databases?: Array<any>;
73
74 componentLoader?: ComponentLoader;
75
76 /**
77 * List of custom pages which will be visible below all resources
78 * @example
79 * pages: {
80 * customPage: {
81 * label: "Custom page",
82 * handler: async (request, response, context) => {
83 * return {
84 * text: 'I am fetched from the backend',
85 * }
86 * },
87 * component: 'CustomPage',
88 * },
89 * anotherPage: {
90 * label: "TypeScript page",
91 * component: 'TestComponent',
92 * },
93 * },
94 */
95 pages?: AdminPages;
96 /**
97 * Array of all Resources which are supported by AdminJS via adapters.
98 * You can pass either resource or resource with an options and thus modify it.
99 * @property {any} resources[].resource
100 * @property {ResourceOptions} resources[].options
101 * @property {Array<FeatureType>} resources[].features
102 *
103 * @see ResourceOptions
104 */
105 resources?: Array<ResourceWithOptions | any>;
106 /**
107 * Option to modify the dashboard
108 */
109 dashboard?: {
110 /**
111 * Handler function which can be triggered using {@link ApiClient#getDashboard}.
112 */

Callers

nothing calls this directly

Calls

no outgoing calls

Tested by

no test coverage detected

Used in the wild real call sites across dependent graphs

searching dependent graphs…