_comuns/dist/tipagemRotas.d.ts

38 lines
1.3 KiB
TypeScript

/** Gerar uma classe que facilita a gestão de rotas com a tipagem das querys */
export declare class TipagemRotas<T = {
[q: string]: string;
}> {
/** Prefixo da url */
PREFIXO: string | undefined;
_caminhoParcial: string;
/** Ao criar novo obijeto de tipagem de rota é necessário passar o caminho parcial
** export const mCaminho = new TipagemRotas<{q:string}>("/caminho")
*/
constructor(caminhoParcial: string, PREFIXO: string | undefined);
/** Retorna o caminho completo da rota
** console.log(mCaminho.caminho)
** "/caminho"
*/
get caminho(): string;
/** Define o caminho completo da rota
** mCaminho.caminho = "/novoCaminho"
** console.log(mCaminho.caminho)
** "/novoCaminho"
** */
set caminho(caminhoParcial: string);
/** Retorna o caminho completo da rota com a query
** console.log(mCaminho.resolve({q:"query"}))
** "http://localhost:3000/caminho?q=query"
*/
resolve(query: T): string;
/** Vai para a url
** mCaminho.ir({q:"query"})
** window.location.href = "http://localhost:3000/caminho?q=query"
*/
ir(query: T): void;
/** Retorna os parametros da url
** console.log(mCaminho.parametros())
** {q:"query"}
*/
parametros(): T;
}