mirror of
https://github.com/meteor/meteor.git
synced 2026-05-02 03:01:46 -04:00
42 lines
1.5 KiB
TypeScript
42 lines
1.5 KiB
TypeScript
import { EJSONable } from 'meteor/ejson';
|
|
|
|
export namespace Session {
|
|
/**
|
|
* Test if a session variable is equal to a value. If inside a
|
|
* reactive computation, invalidate the computation the next
|
|
* time the variable changes to or from the value.
|
|
* @param key The name of the session variable to test
|
|
* @param value The value to test against
|
|
*/
|
|
function equals(key: string, value: string | number | boolean | any): boolean;
|
|
|
|
/**
|
|
* Get the value of a session variable. If inside a reactive
|
|
* computation, invalidate the computation the next time the
|
|
* value of the variable is changed by `Session.set`. This
|
|
* returns a clone of the session value, so if it's an object or an array,
|
|
* mutating the returned value has no effect on the value stored in the
|
|
* session.
|
|
* @param key The name of the session variable to return
|
|
*/
|
|
function get(key: string): any;
|
|
|
|
/**
|
|
* Set a variable in the session. Notify any listeners that the value
|
|
* has changed (eg: redraw templates, and rerun any
|
|
* `Tracker.autorun` computations, that called
|
|
* `Session.get` on this `key`.)
|
|
* @param key The key to set, eg, `selectedItem`
|
|
* @param value The new value for `key`
|
|
*/
|
|
function set(key: string, value: EJSONable | any): void;
|
|
|
|
/**
|
|
* Set a variable in the session if it hasn't been set before.
|
|
* Otherwise works exactly the same as `Session.set`.
|
|
* @param key The key to set, eg, `selectedItem`
|
|
* @param value The new value for `key`
|
|
*/
|
|
function setDefault(key: string, value: EJSONable | any): void;
|
|
}
|