cstd

<!DOCTYPE html> <html> <head> <meta charset='UTF-8'> <title>CoffeeScript standarts</title> <script src='../javascript/application.js'></script> <script src='../javascript/search.js'></script> <link rel='stylesheet' href='../stylesheets/application.css' type='text/css'> </head> <body> <div id='base' data-path='../'></div> <div id='header'> <div id='menu'> <a href='../extra/README.md.html' title='CSTD'> CSTD </a> » <a href='../alphabetical_index.html' title='Index'> Index </a> » <span class='title'>BaseCache</span> </div> </div> <div id='content'> <h1> Class: BaseCache </h1> <table class='box'> <tr> <td>Defined in:</td> <td>lib/cache/base.coffee</td> </tr> <tr> <td>Inherits:</td> <td> <a href='../class/CSObject.html'>CSObject</a> </td> </tr> </table> <h2>Overview</h2> <div class='docstring'> <p>Базовый аппарат кеша, определяет примитивную реализацию и набор необходимых методов. Абстрактный.</p> </div> <div class='tags'> </div> <h2>Direct Known Subclasses</h2> <p class='children'> <a href='../class/LRUCache.html'>LRUCache</a> </p> <h2>Property Summary</h2> <dl class='properties'> <dt id='_data-property'> <span class='signature'> (Map|Object) <b> _data </b> </span> </dt> <dd class='desc'> data is map for 'key': value </dd> <dt id='_control-property'> <span class='signature'> (Map|Object) <b> _control </b> </span> </dt> <dd class='desc'> control list </dd> </dl> <h2>Instance Method Summary</h2> <ul class='summary'> <li> <span class='signature'> <a href='#get-dynamic'> # (*|undefined) <b>get</b><span>(key)</span> </a> </span> <span class='desc'> Полчаем элемент по ключу <code>key</code> или undefined </span> </li> <li> <span class='signature'> <a href='#set-dynamic'> # (BaseCache) <b>set</b><span>(key, value)</span> </a> </span> <span class='desc'> Помещает или обновляет значение <code>value</code> в кэше по ключу <code>key</code> </span> </li> <li> <span class='signature'> <a href='#clear-dynamic'> # (BaseCache) <b>clear</b><span>()</span> </a> </span> <span class='desc'> Очистить кэш </span> </li> <li> <span class='signature'> <a href='#destructor-dynamic'> # (null) <b>destructor</b><span>()</span> </a> </span> <span class='desc'> Очищает кэш и удаляет все связки </span> </li> </ul> <h2> <small>Inherited Method Summary</small> <h3 class='inherited'> Methods inherited from <a href='../class/CSObject.html'>CSObject</a> </h3> <p class='inherited'> <a href='../class/CSObject.html#destructor-dynamic'>#destructor</a> </p> </h2> <h2>Constructor Details</h2> <div class='methods'> <div class='method_details'> <p class='signature' id='constructor-dynamic'> # (void) <b>constructor</b><span>(size)</span> <br> </p> <div class='docstring'> <div class='abstract note'> <strong> This method is abstract. </strong> </div> <p>Создаёт кэш на <code>size</code> элементов</p> </div> <div class='tags'> <h3>Parameters:</h3> <ul class='param'> <li> <span class='name'>size</span> <span class='type'> ( <tt>Number</tt> ) </span> — <span class='desc'>не обязателен в принципе, определяет значение <code>#maxSize</code> если оно не установлено </span> </li> </ul> <h3>Throws:</h3> <ul class='throw'> <li> <span class='type'></span> ( <tt>TypeError</tt> ) — <span class='desc'>если строится абстрактный класс </span> </li> <li> <span class='type'></span> ( <tt>TypeError</tt> ) — <span class='desc'>если <code>size</code> передан, но не число </span> </li> <li> <span class='type'></span> ( <tt>RangeError</tt> ) — <span class='desc'>если <code>size</code> меньше 1 </span> </li> </ul> </div> </div> </div> <h2>Instance Method Details</h2> <div class='methods'> <div class='method_details'> <p class='signature' id='get-dynamic'> # (*|undefined) <b>get</b><span>(key)</span> <br> </p> <div class='docstring'> <p>Полчаем элемент по ключу <code>key</code> или undefined</p> </div> <div class='tags'> <h3>Parameters:</h3> <ul class='param'> <li> <span class='name'>key</span> <span class='type'> ( <tt>String|Number</tt> ) </span> — <span class='desc'>ключ хранимого в кеше значения </span> </li> </ul> <h3>Throws:</h3> <ul class='throw'> <li> <span class='type'></span> ( <tt>Error</tt> ) — <span class='desc'>если аргументов нет или больше одного </span> </li> <li> <span class='type'></span> ( <tt>TypeError</tt> ) — <span class='desc'>если <code>key</code> не вписался в типы </span> </li> </ul> <h3>Returns:</h3> <ul class='return'> <li> <span class='type'></span> ( <tt>*|undefined</tt> ) — <span class='desc'>значение из кеша или что такового нет </span> </li> </ul> </div> </div> <div class='method_details'> <p class='signature' id='set-dynamic'> # (BaseCache) <b>set</b><span>(key, value)</span> <br> </p> <div class='docstring'> <p>Помещает или обновляет значение <code>value</code> в кэше по ключу <code>key</code></p> </div> <div class='tags'> <h3>Parameters:</h3> <ul class='param'> <li> <span class='name'>key</span> <span class='type'> ( <tt>String|Number</tt> ) </span> — <span class='desc'>ключ </span> </li> <li> <span class='name'>value</span> <span class='type'> ( <tt>*</tt> ) </span> — <span class='desc'>не стоит передавать undefined </span> </li> </ul> <h3>Throws:</h3> <ul class='throw'> <li> <span class='type'></span> ( <tt>Error</tt> ) — <span class='desc'>если не два аргумента </span> </li> <li> <span class='type'></span> ( <tt>TypeError</tt> ) — <span class='desc'>если ключ не того типа </span> </li> </ul> <h3>Returns:</h3> <ul class='return'> <li> <span class='type'></span> ( <tt><a href='../class/BaseCache.html'>BaseCache</a></tt> ) — <span class='desc'><code>this</code> </span> </li> </ul> </div> </div> <div class='method_details'> <p class='signature' id='clear-dynamic'> # (BaseCache) <b>clear</b><span>()</span> <br> </p> <div class='docstring'> <p>Очистить кэш</p> </div> <div class='tags'> <h3>Throws:</h3> <ul class='throw'> <li> <span class='type'></span> ( <tt>Error</tt> ) — <span class='desc'>если переданы аргументы </span> </li> </ul> <h3>Returns:</h3> <ul class='return'> <li> <span class='type'></span> ( <tt><a href='../class/BaseCache.html'>BaseCache</a></tt> ) — <span class='desc'><code>this</code> </span> </li> </ul> </div> </div> <div class='method_details'> <p class='signature' id='destructor-dynamic'> # (null) <b>destructor</b><span>()</span> <br> </p> <div class='docstring'> <p>Очищает кэш и удаляет все связки</p> </div> <div class='tags'> <h3>Returns:</h3> <ul class='return'> <li> <span class='type'></span> <tt>null</tt> </li> </ul> </div> </div> </div> </div> <div id='footer'> By <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'> Codo </a> 2.1.0 ✲ Press H to see the keyboard shortcuts ✲ <a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a> ✲ <a href='http://twitter.com/_inossidabile' target='_parent'>@_inossidabile</a> </div> <iframe id='search_frame'></iframe> <div id='fuzzySearch'> <input type='text'> <ol></ol> </div> <div id='help'> <p> Quickly fuzzy find classes, mixins, methods, file: </p> <ul> <li> <span>T</span> Open fuzzy finder dialog </li> </ul> <p> Control the navigation frame: </p> <ul> <li> <span>L</span> Toggle list view </li> <li> <span>C</span> Show class list </li> <li> <span>I</span> Show mixin list </li> <li> <span>F</span> Show file list </li> <li> <span>M</span> Show method list </li> <li> <span>E</span> Show extras list </li> </ul> <p> You can focus and blur the search input: </p> <ul> <li> <span>S</span> Focus search input </li> <li> <span>Esc</span> Blur search input </li> </ul> </div> </body> </html>