Skip to content
Meeko
Type to search the guides and the API reference. Open it from any page with / or Ctrl K; move with the arrow keys and open a result with Enter.
Get started

Contents

On this page

Not translated yet

This page has not been translated into English yet, so it is shown in Spanish.

ApiEndpoint

interfaz

Endpoint de API descubierto en server/api.

ts
import type { ApiEndpoint } from "@meekojs/meeko/server";

Source code src/server/runtime/discovery.ts:36

Declaración #

ts
interface ApiEndpoint {
	readonly kind: 'api'
	readonly file: string
	readonly pathname: string
	readonly method: ApiMethod
	readonly clientKey: string
}

Example #

ts
import type { ApiEndpoint } from "@meekojs/meeko/server";

const endpoint: ApiEndpoint = { kind: "api", file: "/server/api/users/[id].get.ts", pathname: "/api/users/[id]", method: "GET", clientKey: "users.byId" };

Propiedades #

kind #

propiedad sólo lectura

readonly kind: 'api'

Tipo de entrada.

file #

propiedad sólo lectura

readonly file: string

Clave del módulo del handler para el cargador.

pathname #

propiedad sólo lectura

readonly pathname: string

Ruta HTTP con los segmentos dinámicos entre corchetes.

method #

propiedad sólo lectura

readonly method: ApiMethod

Método HTTP.

clientKey #

propiedad sólo lectura

readonly clientKey: string

Ruta del método en el cliente api, separada por puntos.

See also #

Was this page helpful?

Add a comment

It is sent when you choose “Yes” or “No”. Only the page, your answer and the comment are stored: no cookies and no personal data.

0 of 2000 characters

Edit on GitHub: packages/meeko/src/server/runtime/discovery.ts