YUI Library Home

Site Search (YDN & YUIBlog):

# YUI Library Examples: Cookie Utility (beta): Subcookie Example

# Cookie Utility (beta): Subcookie Example

This example shows how to get and set subcookies as well as using conversion functions when retrieving subcookie values.

### Note:

Keep an eye on the Logger console at right to view the log messages associated with this example.

## Subcookie Example

This example begins by setting up a local reference to the Cookie utility:

var Cookie = YAHOO.util.Cookie;

The next three lines attempt to read the values stored in subcookies of the "example" cookie:

var name = Cookie.getSub("example", "name"); var today = Cookie.getSub("example", "today", function(value){ return new Date(value); }); var count = Cookie.getSub("example", "count", Number);

The "name" subcookie stores a string so it is retrieved without specifying a third argument. The "today" subcookie stores a date string, which should be converted to a `Date` object upon retrieval; the third argument of `getSub()` is specified as a custom function that will convert the returned value into a `Date` object. The "count" subcookie contains a number and is converted to an actual JavaScript number by passing in the native `Number` function. If any of these subcookies don't exist, `getSub()` returns `null` (this should be the case the first time you run the example). The retrieved values are output in the logger.

After that, new values are assigned to the various subcookies:

Cookie.setSub("example", "name", "Yahoo!"); Cookie.setSub("example", "today", (new Date()).toString()); Cookie.setSub("example", "count", Math.round(Math.random() * 30));

The "name" subcookie is set to "Yahoo!", the "today" subcookie is set to the value of a new `Date` object, outputting its string representation, and the "count" subcookie is filled with a random number. The next time you run the example, the subcookies should have these values.

### YUI Logger Output:

### Cookie Utility (beta) Examples:

- Simple Cookie Example
- Advanced Cookie Example
- Subcookie Example

### More Cookie Utility (beta) Resources:

- User's Guide (external)
- API Documentation
- Cheat Sheet PDF (external)

Copyright © 2008 Yahoo! Inc. All rights reserved.

Privacy Policy - Terms of Service - Copyright Policy - Job Openings