mirror of
https://github.com/wassname/DefinitelyTyped.git
synced 2026-09-09 11:13:57 +08:00
Masahiro Wakame
@@ -0,0 +1,85 @@
|
||||
/// <reference path="page.d.ts" />
|
||||
|
||||
import page = require("page");
|
||||
|
||||
//***********************************************************************
|
||||
// Basic Example
|
||||
// https://github.com/visionmedia/page.js/tree/master/examples/basic
|
||||
//************************************************************************
|
||||
page.base('/basic');
|
||||
page('/', index);
|
||||
page('/about', about);
|
||||
page('/contact', contact);
|
||||
page('/contact/:contactName', contact);
|
||||
page('/contact/inline/:contactName', ctx => { });
|
||||
page();
|
||||
|
||||
var index: PageJS.Callback = function() {
|
||||
document.querySelector('p')
|
||||
.textContent = 'viewing index';
|
||||
}
|
||||
var about: PageJS.Callback = function() {
|
||||
document.querySelector('p')
|
||||
.textContent = 'viewing about';
|
||||
}
|
||||
var contact: PageJS.Callback = function(ctx) {
|
||||
document.querySelector('p')
|
||||
.textContent = 'viewing contact ' + (ctx.params.contactName || '');
|
||||
}
|
||||
|
||||
//***********************************************************************
|
||||
// State Example
|
||||
// https://github.com/visionmedia/page.js/tree/master/examples/state/app.js
|
||||
//************************************************************************
|
||||
interface Avatars {
|
||||
[idx: string]: string;
|
||||
}
|
||||
var avatars: Avatars = {
|
||||
glottis: 'http://homepage.ntlworld.com/stureek/images/glottis03.jpg',
|
||||
manny: 'http://kprojekt.net/wp-content/uploads/manny.jpg',
|
||||
sal: 'http://homepage.ntlworld.com/stureek/images/sal01.jpg'
|
||||
};
|
||||
|
||||
page.base('/state');
|
||||
page('/', index2);
|
||||
page('/user/:name', load, show);
|
||||
page('*', notfound);
|
||||
page();
|
||||
// everything below is not part of page.js
|
||||
// just callbacks etc..
|
||||
function text(str: string) {
|
||||
document.querySelector('p').textContent = str;
|
||||
}
|
||||
function index2() {
|
||||
text('Click a user below to load their avatar');
|
||||
(<HTMLElement>document.querySelector('img'))
|
||||
.style.display = 'none';
|
||||
}
|
||||
var load: PageJS.Callback = function (ctx, next) {
|
||||
// check if we have .state.avatar already available
|
||||
// this could for example be a cached html fragment.
|
||||
if (ctx.state.avatar) {
|
||||
ctx['avatar'] = ctx.state.avatar;
|
||||
next();
|
||||
return;
|
||||
}
|
||||
// pretend we're querying some database etc
|
||||
setTimeout(function () {
|
||||
// you can assign properties to the context
|
||||
// for use between these functions. The .state
|
||||
// property is what's saved in history.
|
||||
ctx.state.avatar = ctx['avatar'] = avatars[ctx.params.name];
|
||||
ctx.save();
|
||||
next();
|
||||
}, 600);
|
||||
}
|
||||
var show: PageJS.Callback = function (ctx) {
|
||||
var img: any = document.querySelector('img');
|
||||
img.src = ctx['avatar'];
|
||||
img.style.display = 'block';
|
||||
text('Showing ' + ctx.params.name);
|
||||
}
|
||||
function notfound() {
|
||||
document.querySelector('p')
|
||||
.textContent = 'not found';
|
||||
}
|
||||
@@ -0,0 +1 @@
|
||||
--noImplicitAny --module commonjs
|
||||
Vendored
+214
@@ -0,0 +1,214 @@
|
||||
// Type definitions for page v1.5.0
|
||||
// Project: http://visionmedia.github.io/page.js/
|
||||
// Definitions by: Alan Norbauer <http://alan.norbauer.com/>
|
||||
// Definitions: https://github.com/borisyankov/DefinitelyTyped
|
||||
|
||||
declare module PageJS {
|
||||
interface Static {
|
||||
/**
|
||||
* Defines a route mapping path to the given callback(s).
|
||||
*
|
||||
* page('/', user.list)
|
||||
* page('/user/:id', user.load, user.show)
|
||||
* page('/user/:id/edit', user.load, user.edit)
|
||||
* page('*', notfound)
|
||||
*
|
||||
* Links that are not of the same origin are disregarded and will not be dispatched.
|
||||
*/
|
||||
(path: string, ...callbacks: Callback[]): void;
|
||||
/**
|
||||
* This is equivalent to page('*', callback) for generic "middleware".
|
||||
*/
|
||||
(callback: Callback): void;
|
||||
/**
|
||||
* Navigate to the given path.
|
||||
*
|
||||
* $('.view').click(function(e){
|
||||
* page('/user/12')
|
||||
* e.preventDefault()
|
||||
* })
|
||||
*/
|
||||
(path: string): void;
|
||||
/**
|
||||
* Setup redirect form one path to other.
|
||||
*/
|
||||
(fromPath: string, toPath: string): void;
|
||||
/**
|
||||
* Register page's popstate / click bindings. If you're doing selective binding you'll like want to pass { click: false } to specify this yourself. The following options are available:
|
||||
*
|
||||
* - click bind to click events [true]
|
||||
* - popstate bind to popstate[true]
|
||||
* - dispatch perform initial dispatch[true]
|
||||
* - hashbang add #!before urls[false]
|
||||
*
|
||||
* If you wish to load serve initial content from the server you likely will want to set dispatch to false.
|
||||
*/
|
||||
(options: Options): void;
|
||||
/**
|
||||
* Register page's popstate / click bindings. If you're doing selective binding you'll like want to pass { click: false } to specify this yourself. The following options are available:
|
||||
*
|
||||
* - click bind to click events [true]
|
||||
* - popstate bind to popstate[true]
|
||||
* - dispatch perform initial dispatch[true]
|
||||
* - hashbang add #!before urls[false]
|
||||
*
|
||||
* If you wish to load serve initial content from the server you likely will want to set dispatch to false.
|
||||
*/
|
||||
(): void;
|
||||
|
||||
/**
|
||||
* Identical to page(fromPath, toPath)
|
||||
*/
|
||||
redirect(fromPath: string, toPath: string): void;
|
||||
/**
|
||||
* Calling page.redirect with only a string as the first parameter redirects to another route. Waits for the current route to push state and after replaces it with the new one leaving the browser history clean.
|
||||
*
|
||||
* page('/default', function(){
|
||||
* // some logic to decide which route to redirect to
|
||||
* if(admin) {
|
||||
* page.redirect('/admin');
|
||||
* } else {
|
||||
* page.redirect('/guest');
|
||||
* }
|
||||
* });
|
||||
*
|
||||
* page('/default');
|
||||
*
|
||||
*/
|
||||
redirect(page: string): void;
|
||||
/**
|
||||
* Navigate to the given path.
|
||||
*
|
||||
* $('.view').click(function(e){
|
||||
* page('/user/12')
|
||||
* e.preventDefault()
|
||||
* })
|
||||
*
|
||||
* Identical to page(path).
|
||||
*/
|
||||
show(path: string): void;
|
||||
/**
|
||||
* Register page's popstate / click bindings. If you're doing selective binding you'll like want to pass { click: false } to specify this yourself. The following options are available:
|
||||
*
|
||||
* - click bind to click events [true]
|
||||
* - popstate bind to popstate[true]
|
||||
* - dispatch perform initial dispatch[true]
|
||||
* - hashbang add #!before urls[false]
|
||||
*
|
||||
* If you wish to load serve initial content from the server you likely will want to set dispatch to false.
|
||||
*
|
||||
* Identical to page([options]).
|
||||
*/
|
||||
start(options: Options): void;
|
||||
/**
|
||||
* Register page's popstate / click bindings. If you're doing selective binding you'll like want to pass { click: false } to specify this yourself. The following options are available:
|
||||
*
|
||||
* - click bind to click events [true]
|
||||
* - popstate bind to popstate[true]
|
||||
* - dispatch perform initial dispatch[true]
|
||||
* - hashbang add #!before urls[false]
|
||||
*
|
||||
* If you wish to load serve initial content from the server you likely will want to set dispatch to false.
|
||||
*/
|
||||
start(): void;
|
||||
/**
|
||||
* Unbind both the popstate and click handlers.
|
||||
*/
|
||||
stop(): void;
|
||||
/**
|
||||
* Get or set the base path. For example if page.js is operating within /blog/* set the base path to "/blog".
|
||||
*/
|
||||
base(path?: string): void;
|
||||
/**
|
||||
* Defines an exit route mapping path to the given callback(s).
|
||||
*
|
||||
* Exit routes are called when a page changes, using the context from the previous change. For example:
|
||||
*
|
||||
* page('/sidebar', function(ctx, next) {
|
||||
* sidebar.open = true
|
||||
* next()
|
||||
* })
|
||||
*
|
||||
* page.exit('/sidebar', function(next) {
|
||||
* sidebar.open = false
|
||||
* next()
|
||||
* })
|
||||
*/
|
||||
exit(path: string, callback: Callback, moreCallbacks?: Callback[]): void;
|
||||
/**
|
||||
* Equivalent to page.exit('*', callback).
|
||||
*/
|
||||
exit(callback: Callback): void;
|
||||
}
|
||||
|
||||
interface Options {
|
||||
/**
|
||||
* bind to click events (default = true)
|
||||
*/
|
||||
click?: boolean;
|
||||
/**
|
||||
* bind to popstate (default = true)
|
||||
*/
|
||||
popstate?: boolean;
|
||||
/**
|
||||
* perform initial dispatch (default = true)
|
||||
*/
|
||||
dispatch?: boolean;
|
||||
/**
|
||||
* add #!before urls (default = false)
|
||||
*/
|
||||
hashbang?: boolean;
|
||||
}
|
||||
|
||||
interface Callback {
|
||||
(ctx: Context, next: () => any): any;
|
||||
}
|
||||
|
||||
/**
|
||||
* Routes are passed Context objects, these may be used to share state, for example ctx.user =, as well as the history "state" ctx.state that the pushState API provides.
|
||||
*/
|
||||
interface Context {
|
||||
[idx: string]: any;
|
||||
/**
|
||||
* Saves the context using replaceState(). For example this is useful for caching HTML or other resources that were loaded for when a user presses "back".
|
||||
*/
|
||||
save: () => void;
|
||||
/**
|
||||
* If true, marks the context as handled to prevent default 404 behaviour. For example this is useful for the routes with interminate quantity of the callbacks.
|
||||
*/
|
||||
handled: boolean;
|
||||
/**
|
||||
* Pathname including the "base" (if any) and query string "/admin/login?foo=bar".
|
||||
*/
|
||||
canonicalPath: string;
|
||||
/**
|
||||
* Pathname and query string "/login?foo=bar".
|
||||
*/
|
||||
path: string;
|
||||
/**
|
||||
* Query string void of leading ? such as "foo=bar", defaults to "".
|
||||
*/
|
||||
queryString: string;
|
||||
/**
|
||||
* The pathname void of query string "/login".
|
||||
*/
|
||||
pathname: string;
|
||||
/**
|
||||
* The pushState state object.
|
||||
*/
|
||||
state: any;
|
||||
/**
|
||||
* The pushState title.
|
||||
*/
|
||||
title: string;
|
||||
/**
|
||||
* The parameters from the url, e.g. /user/:id => Context.params.id
|
||||
*/
|
||||
params: any;
|
||||
}
|
||||
}
|
||||
|
||||
declare module "page" {
|
||||
var page: PageJS.Static;
|
||||
export = page;
|
||||
}
|
||||
Reference in New Issue
Block a user