diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..df36ad2 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +xml/js.xml diff --git a/build.hxml b/build.hxml index acd7ced..4efa1c5 100644 --- a/build.hxml +++ b/build.hxml @@ -17,7 +17,7 @@ mw.CookieSession mw.Cors mw.ExpressBrute mw.ExpressForceSSL -mw.Favicon +mw.FavIcon mw.Jwt mw.Morgan mw.OnFinished diff --git a/docs/404.html b/docs/404.html new file mode 100644 index 0000000..002922c --- /dev/null +++ b/docs/404.html @@ -0,0 +1 @@ +File not found - Express Externs and Middleware for Haxe

404 Page not found

Page not found, sorry.

\ No newline at end of file diff --git a/docs/bootstrap/css/bootstrap-select.min.css b/docs/bootstrap/css/bootstrap-select.min.css new file mode 100644 index 0000000..b3021ae --- /dev/null +++ b/docs/bootstrap/css/bootstrap-select.min.css @@ -0,0 +1,6 @@ +/*! + * Bootstrap-select v1.6.3 (http://silviomoreto.github.io/bootstrap-select/) + * + * Copyright 2013-2014 bootstrap-select + * Licensed under MIT (https://github.com/silviomoreto/bootstrap-select/blob/master/LICENSE) + */.bootstrap-select{width:220px \0}.bootstrap-select>.btn{width:100%;padding-right:25px}.error .bootstrap-select .btn{border:1px solid #b94a48}.control-group.error .bootstrap-select .dropdown-toggle{border-color:#b94a48}.bootstrap-select.fit-width{width:auto!important}.bootstrap-select:not([class*=col-]):not([class*=form-control]):not(.input-group-btn){width:220px}.bootstrap-select .btn:focus{outline:thin dotted #333!important;outline:5px auto -webkit-focus-ring-color!important;outline-offset:-2px}.bootstrap-select.form-control{margin-bottom:0;padding:0;border:none}.bootstrap-select.form-control:not([class*=col-]){width:100%}.bootstrap-select.btn-group:not(.input-group-btn),.bootstrap-select.btn-group[class*=col-]{float:none;display:inline-block;margin-left:0}.bootstrap-select.btn-group.dropdown-menu-right,.bootstrap-select.btn-group[class*=col-].dropdown-menu-right,.row-fluid .bootstrap-select.btn-group[class*=col-].dropdown-menu-right{float:right}.form-search .bootstrap-select.btn-group,.form-inline .bootstrap-select.btn-group,.form-horizontal .bootstrap-select.btn-group,.form-group .bootstrap-select.btn-group{margin-bottom:0}.form-group-lg .bootstrap-select.btn-group.form-control,.form-group-sm .bootstrap-select.btn-group.form-control{padding:0}.form-inline .bootstrap-select.btn-group .form-control{width:100%}.input-append .bootstrap-select.btn-group{margin-left:-1px}.input-prepend .bootstrap-select.btn-group{margin-right:-1px}.bootstrap-select.btn-group>.disabled{cursor:not-allowed}.bootstrap-select.btn-group>.disabled:focus{outline:0!important}.bootstrap-select.btn-group .btn .filter-option{display:inline-block;overflow:hidden;width:100%;text-align:left}.bootstrap-select.btn-group .btn .caret{position:absolute;top:50%;right:12px;margin-top:-2px;vertical-align:middle}.bootstrap-select.btn-group[class*=col-] .btn{width:100%}.bootstrap-select.btn-group .dropdown-menu{min-width:100%;z-index:1035;-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}.bootstrap-select.btn-group .dropdown-menu.inner{position:static;border:0;padding:0;margin:0;border-radius:0;-webkit-box-shadow:none;box-shadow:none}.bootstrap-select.btn-group .dropdown-menu li{position:relative}.bootstrap-select.btn-group .dropdown-menu li:not(.disabled) a:hover small,.bootstrap-select.btn-group .dropdown-menu li:not(.disabled) a:focus small,.bootstrap-select.btn-group .dropdown-menu li.active:not(.disabled) a small{color:#64b1d8;color:rgba(100,177,216,.4)}.bootstrap-select.btn-group .dropdown-menu li.disabled a{cursor:not-allowed}.bootstrap-select.btn-group .dropdown-menu li a{cursor:pointer}.bootstrap-select.btn-group .dropdown-menu li a.opt{position:relative;padding-left:2.25em}.bootstrap-select.btn-group .dropdown-menu li a span.check-mark{display:none}.bootstrap-select.btn-group .dropdown-menu li a span.text{display:inline-block}.bootstrap-select.btn-group .dropdown-menu li small{padding-left:.5em}.bootstrap-select.btn-group .dropdown-menu .notify{position:absolute;bottom:5px;width:96%;margin:0 2%;min-height:26px;padding:3px 5px;background:#f5f5f5;border:1px solid #e3e3e3;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.05);box-shadow:inset 0 1px 1px rgba(0,0,0,.05);pointer-events:none;opacity:.9;-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}.bootstrap-select.btn-group .no-results{padding:3px;background:#f5f5f5;margin:0 5px}.bootstrap-select.btn-group.fit-width .btn .filter-option{position:static}.bootstrap-select.btn-group.fit-width .btn .caret{position:static;top:auto;margin-top:-1px}.bootstrap-select.btn-group.show-tick .dropdown-menu li.selected a span.check-mark{position:absolute;display:inline-block;right:15px;margin-top:5px}.bootstrap-select.btn-group.show-tick .dropdown-menu li a span.text{margin-right:34px}.bootstrap-select.show-menu-arrow.open>.btn{z-index:1035+1}.bootstrap-select.show-menu-arrow .dropdown-toggle:before{content:'';border-left:7px solid transparent;border-right:7px solid transparent;border-bottom-width:7px;border-bottom-style:solid;border-bottom-color:#ccc;border-bottom-color:rgba(204,204,204,.2);position:absolute;bottom:-4px;left:9px;display:none}.bootstrap-select.show-menu-arrow .dropdown-toggle:after{content:'';border-left:6px solid transparent;border-right:6px solid transparent;border-bottom:6px solid #fff;position:absolute;bottom:-4px;left:10px;display:none}.bootstrap-select.show-menu-arrow.dropup .dropdown-toggle:before{bottom:auto;top:-3px;border-bottom:0;border-top-width:7px;border-top-style:solid;border-top-color:#ccc;border-top-color:rgba(204,204,204,.2)}.bootstrap-select.show-menu-arrow.dropup .dropdown-toggle:after{bottom:auto;top:-3px;border-top:6px solid #fff;border-bottom:0}.bootstrap-select.show-menu-arrow.pull-right .dropdown-toggle:before{right:12px;left:auto}.bootstrap-select.show-menu-arrow.pull-right .dropdown-toggle:after{right:13px;left:auto}.bootstrap-select.show-menu-arrow.open>.dropdown-toggle:before,.bootstrap-select.show-menu-arrow.open>.dropdown-toggle:after{display:block}.bs-searchbox,.bs-actionsbox{padding:4px 8px}.bs-actionsbox{float:left;width:100%;-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}.bs-actionsbox .btn-group button{width:50%}.bs-searchbox+.bs-actionsbox{padding:0 8px 4px}.bs-searchbox input.form-control{margin-bottom:0;width:100%}.mobile-device{position:absolute;top:0;left:0;display:block!important;width:100%;height:100%!important;opacity:0} \ No newline at end of file diff --git a/docs/bootstrap/js/bootstrap-select.min.js b/docs/bootstrap/js/bootstrap-select.min.js new file mode 100644 index 0000000..074e383 --- /dev/null +++ b/docs/bootstrap/js/bootstrap-select.min.js @@ -0,0 +1,8 @@ +/*! + * Bootstrap-select v1.6.3 (http://silviomoreto.github.io/bootstrap-select/) + * + * Copyright 2013-2014 bootstrap-select + * Licensed under MIT (https://github.com/silviomoreto/bootstrap-select/blob/master/LICENSE) + */ +!function(a){"use strict";function b(a,b){return a.toUpperCase().indexOf(b.toUpperCase())>-1}function c(b){var c=[{re:/[\xC0-\xC6]/g,ch:"A"},{re:/[\xE0-\xE6]/g,ch:"a"},{re:/[\xC8-\xCB]/g,ch:"E"},{re:/[\xE8-\xEB]/g,ch:"e"},{re:/[\xCC-\xCF]/g,ch:"I"},{re:/[\xEC-\xEF]/g,ch:"i"},{re:/[\xD2-\xD6]/g,ch:"O"},{re:/[\xF2-\xF6]/g,ch:"o"},{re:/[\xD9-\xDC]/g,ch:"U"},{re:/[\xF9-\xFC]/g,ch:"u"},{re:/[\xC7-\xE7]/g,ch:"c"},{re:/[\xD1]/g,ch:"N"},{re:/[\xF1]/g,ch:"n"}];return a.each(c,function(){b=b.replace(this.re,this.ch)}),b}function d(a){var b={"&":"&","<":"<",">":">",'"':""","'":"'","`":"`"},c="(?:"+Object.keys(b).join("|")+")",d=new RegExp(c),e=new RegExp(c,"g"),f=null==a?"":""+a;return d.test(f)?f.replace(e,function(a){return b[a]}):f}function e(b,c){var d=arguments,e=b,b=d[0],c=d[1];[].shift.apply(d),"undefined"==typeof b&&(b=e);var g,h=this.each(function(){var e=a(this);if(e.is("select")){var h=e.data("selectpicker"),i="object"==typeof b&&b;if(h){if(i)for(var j in i)i.hasOwnProperty(j)&&(h.options[j]=i[j])}else{var k=a.extend({},f.DEFAULTS,a.fn.selectpicker.defaults||{},e.data(),i);e.data("selectpicker",h=new f(this,k,c))}"string"==typeof b&&(g=h[b]instanceof Function?h[b].apply(h,d):h.options[b])}});return"undefined"!=typeof g?g:h}a.expr[":"].icontains=function(c,d,e){return b(a(c).text(),e[3])},a.expr[":"].aicontains=function(c,d,e){return b(a(c).data("normalizedText")||a(c).text(),e[3])};var f=function(b,c,d){d&&(d.stopPropagation(),d.preventDefault()),this.$element=a(b),this.$newElement=null,this.$button=null,this.$menu=null,this.$lis=null,this.options=c,null===this.options.title&&(this.options.title=this.$element.attr("title")),this.val=f.prototype.val,this.render=f.prototype.render,this.refresh=f.prototype.refresh,this.setStyle=f.prototype.setStyle,this.selectAll=f.prototype.selectAll,this.deselectAll=f.prototype.deselectAll,this.destroy=f.prototype.remove,this.remove=f.prototype.remove,this.show=f.prototype.show,this.hide=f.prototype.hide,this.init()};f.VERSION="1.6.3",f.DEFAULTS={noneSelectedText:"Nothing selected",noneResultsText:"No results match",countSelectedText:function(a){return 1==a?"{0} item selected":"{0} items selected"},maxOptionsText:function(a,b){var c=[];return c[0]=1==a?"Limit reached ({n} item max)":"Limit reached ({n} items max)",c[1]=1==b?"Group limit reached ({n} item max)":"Group limit reached ({n} items max)",c},selectAllText:"Select All",deselectAllText:"Deselect All",multipleSeparator:", ",style:"btn-default",size:"auto",title:null,selectedTextFormat:"values",width:!1,container:!1,hideDisabled:!1,showSubtext:!1,showIcon:!0,showContent:!0,dropupAuto:!0,header:!1,liveSearch:!1,actionsBox:!1,iconBase:"glyphicon",tickIcon:"glyphicon-ok",maxOptions:!1,mobile:!1,selectOnTab:!1,dropdownAlignRight:!1,searchAccentInsensitive:!1},f.prototype={constructor:f,init:function(){var b=this,c=this.$element.attr("id");this.$element.hide(),this.multiple=this.$element.prop("multiple"),this.autofocus=this.$element.prop("autofocus"),this.$newElement=this.createView(),this.$element.after(this.$newElement),this.$menu=this.$newElement.find("> .dropdown-menu"),this.$button=this.$newElement.find("> button"),this.$searchbox=this.$newElement.find("input"),this.options.dropdownAlignRight&&this.$menu.addClass("dropdown-menu-right"),"undefined"!=typeof c&&(this.$button.attr("data-id",c),a('label[for="'+c+'"]').click(function(a){a.preventDefault(),b.$button.focus()})),this.checkDisabled(),this.clickListener(),this.options.liveSearch&&this.liveSearchListener(),this.render(),this.liHeight(),this.setStyle(),this.setWidth(),this.options.container&&this.selectPosition(),this.$menu.data("this",this),this.$newElement.data("this",this),this.options.mobile&&this.mobile()},createDropdown:function(){var b=this.multiple?" show-tick":"",c=this.$element.parent().hasClass("input-group")?" input-group-btn":"",d=this.autofocus?" autofocus":"",e=this.$element.parents().hasClass("form-group-lg")?" btn-lg":this.$element.parents().hasClass("form-group-sm")?" btn-sm":"",f=this.options.header?'
'+this.options.header+"
":"",g=this.options.liveSearch?'
':"",h=this.options.actionsBox?'
":"",i='
'+f+g+h+'
';return a(i)},createView:function(){var a=this.createDropdown(),b=this.createLi();return a.find("ul").append(b),a},reloadLi:function(){this.destroyLi();var a=this.createLi();this.$menu.find("ul").append(a)},destroyLi:function(){this.$menu.find("li").remove()},createLi:function(){var b=this,e=[],f=0,g=function(a,b,c){return""+a+""},h=function(a,e,f,g){var h=c(d(a));return''+a+''};return this.$element.find("option").each(function(){var c=a(this),d=c.attr("class")||"",i=c.attr("style"),j=c.data("content")?c.data("content"):c.html(),k="undefined"!=typeof c.data("subtext")?''+c.data("subtext")+"":"",l="undefined"!=typeof c.data("icon")?' ':"",m=c.is(":disabled")||c.parent().is(":disabled"),n=c[0].index;if(""!==l&&m&&(l=""+l+""),c.data("content")||(j=l+''+j+k+""),!b.options.hideDisabled||!m)if(c.parent().is("optgroup")&&c.data("divider")!==!0){if(0===c.index()){f+=1;var o=c.parent().attr("label"),p="undefined"!=typeof c.parent().data("subtext")?''+c.parent().data("subtext")+"":"",q=c.parent().data("icon")?' ':"";o=q+''+o+p+"",0!==n&&e.length>0&&e.push(g("",null,"divider")),e.push(g(o,null,"dropdown-header"))}e.push(g(h(j,"opt "+d,i,f),n))}else e.push(c.data("divider")===!0?g("",n,"divider"):c.data("hidden")===!0?g(h(j,d,i),n,"hide is-hidden"):g(h(j,d,i),n))}),this.multiple||0!==this.$element.find("option:selected").length||this.options.title||this.$element.find("option").eq(0).prop("selected",!0).attr("selected","selected"),a(e.join(""))},findLis:function(){return null==this.$lis&&(this.$lis=this.$menu.find("li")),this.$lis},render:function(b){var c=this;b!==!1&&this.$element.find("option").each(function(b){c.setDisabled(b,a(this).is(":disabled")||a(this).parent().is(":disabled")),c.setSelected(b,a(this).is(":selected"))}),this.tabIndex();var e=this.options.hideDisabled?":not([disabled])":"",f=this.$element.find("option:selected"+e).map(function(){var b,d=a(this),e=d.data("icon")&&c.options.showIcon?' ':"";return b=c.options.showSubtext&&d.attr("data-subtext")&&!c.multiple?' '+d.data("subtext")+"":"",d.data("content")&&c.options.showContent?d.data("content"):"undefined"!=typeof d.attr("title")?d.attr("title"):e+d.html()+b}).toArray(),g=this.multiple?f.join(this.options.multipleSeparator):f[0];if(this.multiple&&this.options.selectedTextFormat.indexOf("count")>-1){var h=this.options.selectedTextFormat.split(">");if(h.length>1&&f.length>h[1]||1==h.length&&f.length>=2){e=this.options.hideDisabled?", [disabled]":"";var i=this.$element.find("option").not('[data-divider="true"], [data-hidden="true"]'+e).length,j="function"==typeof this.options.countSelectedText?this.options.countSelectedText(f.length,i):this.options.countSelectedText;g=j.replace("{0}",f.length.toString()).replace("{1}",i.toString())}}this.options.title=this.$element.attr("title"),"static"==this.options.selectedTextFormat&&(g=this.options.title),g||(g="undefined"!=typeof this.options.title?this.options.title:this.options.noneSelectedText),this.$button.attr("title",d(g)),this.$newElement.find(".filter-option").html(g)},setStyle:function(a,b){this.$element.attr("class")&&this.$newElement.addClass(this.$element.attr("class").replace(/selectpicker|mobile-device|validate\[.*\]/gi,""));var c=a?a:this.options.style;"add"==b?this.$button.addClass(c):"remove"==b?this.$button.removeClass(c):(this.$button.removeClass(this.options.style),this.$button.addClass(c))},liHeight:function(){if(this.options.size!==!1){var a=this.$menu.parent().clone().find("> .dropdown-toggle").prop("autofocus",!1).end().appendTo("body"),b=a.addClass("open").find("> .dropdown-menu"),c=b.find("li").not(".divider").not(".dropdown-header").filter(":visible").children("a").outerHeight(),d=this.options.header?b.find(".popover-title").outerHeight():0,e=this.options.liveSearch?b.find(".bs-searchbox").outerHeight():0,f=this.options.actionsBox?b.find(".bs-actionsbox").outerHeight():0;a.remove(),this.$newElement.data("liHeight",c).data("headerHeight",d).data("searchHeight",e).data("actionsHeight",f)}},setSize:function(){this.findLis();var b,c,d,e=this,f=this.$menu,g=f.find(".inner"),h=this.$newElement.outerHeight(),i=this.$newElement.data("liHeight"),j=this.$newElement.data("headerHeight"),k=this.$newElement.data("searchHeight"),l=this.$newElement.data("actionsHeight"),m=this.$lis.filter(".divider").outerHeight(!0),n=parseInt(f.css("padding-top"))+parseInt(f.css("padding-bottom"))+parseInt(f.css("border-top-width"))+parseInt(f.css("border-bottom-width")),o=this.options.hideDisabled?", .disabled":"",p=a(window),q=n+parseInt(f.css("margin-top"))+parseInt(f.css("margin-bottom"))+2,r=function(){c=e.$newElement.offset().top-p.scrollTop(),d=p.height()-c-h};if(r(),this.options.header&&f.css("padding-top",0),"auto"==this.options.size){var s=function(){var a,h=e.$lis.not(".hide");r(),b=d-q,e.options.dropupAuto&&e.$newElement.toggleClass("dropup",c>d&&b-q3?3*i+q-2:0,f.css({"max-height":b+"px",overflow:"hidden","min-height":a+j+k+l+"px"}),g.css({"max-height":b-j-k-l-n+"px","overflow-y":"auto","min-height":Math.max(a-n,0)+"px"})};s(),this.$searchbox.off("input.getSize propertychange.getSize").on("input.getSize propertychange.getSize",s),a(window).off("resize.getSize").on("resize.getSize",s),a(window).off("scroll.getSize").on("scroll.getSize",s)}else if(this.options.size&&"auto"!=this.options.size&&f.find("li"+o).length>this.options.size){var t=this.$lis.not(".divider"+o).find(" > *").slice(0,this.options.size).last().parent().index(),u=this.$lis.slice(0,t+1).filter(".divider").length;b=i*this.options.size+u*m+n,e.options.dropupAuto&&this.$newElement.toggleClass("dropup",c>d&&b .dropdown-menu").css("width"),c=a.css("width","auto").find("> button").css("width");a.remove(),this.$newElement.css("width",Math.max(parseInt(b),parseInt(c))+"px")}else"fit"==this.options.width?(this.$menu.css("min-width",""),this.$newElement.css("width","").addClass("fit-width")):this.options.width?(this.$menu.css("min-width",""),this.$newElement.css("width",this.options.width)):(this.$menu.css("min-width",""),this.$newElement.css("width",""));this.$newElement.hasClass("fit-width")&&"fit"!==this.options.width&&this.$newElement.removeClass("fit-width")},selectPosition:function(){var b,c,d=this,e="
",f=a(e),g=function(a){f.addClass(a.attr("class").replace(/form-control/gi,"")).toggleClass("dropup",a.hasClass("dropup")),b=a.offset(),c=a.hasClass("dropup")?0:a[0].offsetHeight,f.css({top:b.top+c,left:b.left,width:a[0].offsetWidth,position:"absolute"})};this.$newElement.on("click",function(){d.isDisabled()||(g(a(this)),f.appendTo(d.options.container),f.toggleClass("open",!a(this).hasClass("open")),f.append(d.$menu))}),a(window).resize(function(){g(d.$newElement)}),a(window).on("scroll",function(){g(d.$newElement)}),a("html").on("click",function(b){a(b.target).closest(d.$newElement).length<1&&f.removeClass("open")})},setSelected:function(a,b){this.findLis(),this.$lis.filter('[data-original-index="'+a+'"]').toggleClass("selected",b)},setDisabled:function(a,b){this.findLis(),b?this.$lis.filter('[data-original-index="'+a+'"]').addClass("disabled").find("a").attr("href","#").attr("tabindex",-1):this.$lis.filter('[data-original-index="'+a+'"]').removeClass("disabled").find("a").removeAttr("href").attr("tabindex",0)},isDisabled:function(){return this.$element.is(":disabled")},checkDisabled:function(){var a=this;this.isDisabled()?this.$button.addClass("disabled").attr("tabindex",-1):(this.$button.hasClass("disabled")&&this.$button.removeClass("disabled"),-1==this.$button.attr("tabindex")&&(this.$element.data("tabindex")||this.$button.removeAttr("tabindex"))),this.$button.click(function(){return!a.isDisabled()})},tabIndex:function(){this.$element.is("[tabindex]")&&(this.$element.data("tabindex",this.$element.attr("tabindex")),this.$button.attr("tabindex",this.$element.data("tabindex")))},clickListener:function(){var b=this;this.$newElement.on("touchstart.dropdown",".dropdown-menu",function(a){a.stopPropagation()}),this.$newElement.on("click",function(){b.setSize(),b.options.liveSearch||b.multiple||setTimeout(function(){b.$menu.find(".selected a").focus()},10)}),this.$menu.on("click","li a",function(c){var d=a(this),e=d.parent().data("originalIndex"),f=b.$element.val(),g=b.$element.prop("selectedIndex");if(b.multiple&&c.stopPropagation(),c.preventDefault(),!b.isDisabled()&&!d.parent().hasClass("disabled")){var h=b.$element.find("option"),i=h.eq(e),j=i.prop("selected"),k=i.parent("optgroup"),l=b.options.maxOptions,m=k.data("maxOptions")||!1;if(b.multiple){if(i.prop("selected",!j),b.setSelected(e,!j),d.blur(),l!==!1||m!==!1){var n=l
');q[2]&&(r=r.replace("{var}",q[2][l>1?0:1]),s=s.replace("{var}",q[2][m>1?0:1])),i.prop("selected",!1),b.$menu.append(t),l&&n&&(t.append(a("
"+r+"
")),b.$element.trigger("maxReached.bs.select")),m&&o&&(t.append(a("
"+s+"
")),b.$element.trigger("maxReachedGrp.bs.select")),setTimeout(function(){b.setSelected(e,!1)},10),t.delay(750).fadeOut(300,function(){a(this).remove()})}}}else h.prop("selected",!1),i.prop("selected",!0),b.$menu.find(".selected").removeClass("selected"),b.setSelected(e,!0);b.multiple?b.options.liveSearch&&b.$searchbox.focus():b.$button.focus(),(f!=b.$element.val()&&b.multiple||g!=b.$element.prop("selectedIndex")&&!b.multiple)&&b.$element.change()}}),this.$menu.on("click","li.disabled a, .popover-title, .popover-title :not(.close)",function(a){a.target==this&&(a.preventDefault(),a.stopPropagation(),b.options.liveSearch?b.$searchbox.focus():b.$button.focus())}),this.$menu.on("click","li.divider, li.dropdown-header",function(a){a.preventDefault(),a.stopPropagation(),b.options.liveSearch?b.$searchbox.focus():b.$button.focus()}),this.$menu.on("click",".popover-title .close",function(){b.$button.focus()}),this.$searchbox.on("click",function(a){a.stopPropagation()}),this.$menu.on("click",".actions-btn",function(c){b.options.liveSearch?b.$searchbox.focus():b.$button.focus(),c.preventDefault(),c.stopPropagation(),a(this).is(".bs-select-all")?b.selectAll():b.deselectAll(),b.$element.change()}),this.$element.change(function(){b.render(!1)})},liveSearchListener:function(){var b=this,e=a('
  • ');this.$newElement.on("click.dropdown.data-api touchstart.dropdown.data-api",function(){b.$menu.find(".active").removeClass("active"),b.$searchbox.val()&&(b.$searchbox.val(""),b.$lis.not(".is-hidden").removeClass("hide"),e.parent().length&&e.remove()),b.multiple||b.$menu.find(".selected").addClass("active"),setTimeout(function(){b.$searchbox.focus()},10)}),this.$searchbox.on("click.dropdown.data-api focus.dropdown.data-api touchend.dropdown.data-api",function(a){a.stopPropagation()}),this.$searchbox.on("input propertychange",function(){b.$searchbox.val()?(b.options.searchAccentInsensitive?b.$lis.not(".is-hidden").removeClass("hide").find("a").not(":aicontains("+c(b.$searchbox.val())+")").parent().addClass("hide"):b.$lis.not(".is-hidden").removeClass("hide").find("a").not(":icontains("+b.$searchbox.val()+")").parent().addClass("hide"),b.$menu.find("li").filter(":visible:not(.no-results)").length?e.parent().length&&e.remove():(e.parent().length&&e.remove(),e.html(b.options.noneResultsText+' "'+d(b.$searchbox.val())+'"').show(),b.$menu.find("li").last().after(e))):(b.$lis.not(".is-hidden").removeClass("hide"),e.parent().length&&e.remove()),b.$menu.find("li.active").removeClass("active"),b.$menu.find("li").filter(":visible:not(.divider)").eq(0).addClass("active").find("a").focus(),a(this).focus()})},val:function(a){return"undefined"!=typeof a?(this.$element.val(a),this.render(),this.$element):this.$element.val()},selectAll:function(){this.findLis(),this.$lis.not(".divider").not(".disabled").not(".selected").filter(":visible").find("a").click()},deselectAll:function(){this.findLis(),this.$lis.not(".divider").not(".disabled").filter(".selected").filter(":visible").find("a").click()},keydown:function(b){var d,e,f,g,h,i,j,k,l,m=a(this),n=m.is("input")?m.parent().parent():m.parent(),o=n.data("this"),p={32:" ",48:"0",49:"1",50:"2",51:"3",52:"4",53:"5",54:"6",55:"7",56:"8",57:"9",59:";",65:"a",66:"b",67:"c",68:"d",69:"e",70:"f",71:"g",72:"h",73:"i",74:"j",75:"k",76:"l",77:"m",78:"n",79:"o",80:"p",81:"q",82:"r",83:"s",84:"t",85:"u",86:"v",87:"w",88:"x",89:"y",90:"z",96:"0",97:"1",98:"2",99:"3",100:"4",101:"5",102:"6",103:"7",104:"8",105:"9"};if(o.options.liveSearch&&(n=m.parent().parent()),o.options.container&&(n=o.$menu),d=a("[role=menu] li a",n),l=o.$menu.parent().hasClass("open"),!l&&/([0-9]|[A-z])/.test(String.fromCharCode(b.keyCode))&&(o.options.container?o.$newElement.trigger("click"):(o.setSize(),o.$menu.parent().addClass("open"),l=!0),o.$searchbox.focus()),o.options.liveSearch&&(/(^9$|27)/.test(b.keyCode.toString(10))&&l&&0===o.$menu.find(".active").length&&(b.preventDefault(),o.$menu.parent().removeClass("open"),o.$button.focus()),d=a("[role=menu] li:not(.divider):not(.dropdown-header):visible",n),m.val()||/(38|40)/.test(b.keyCode.toString(10))||0===d.filter(".active").length&&(d=o.$newElement.find("li").filter(o.options.searchAccentInsensitive?":aicontains("+c(p[b.keyCode])+")":":icontains("+p[b.keyCode]+")"))),d.length){if(/(38|40)/.test(b.keyCode.toString(10)))e=d.index(d.filter(":focus")),g=d.parent(":not(.disabled):visible").first().index(),h=d.parent(":not(.disabled):visible").last().index(),f=d.eq(e).parent().nextAll(":not(.disabled):visible").eq(0).index(),i=d.eq(e).parent().prevAll(":not(.disabled):visible").eq(0).index(),j=d.eq(f).parent().prevAll(":not(.disabled):visible").eq(0).index(),o.options.liveSearch&&(d.each(function(b){a(this).is(":not(.disabled)")&&a(this).data("index",b)}),e=d.index(d.filter(".active")),g=d.filter(":not(.disabled):visible").first().data("index"),h=d.filter(":not(.disabled):visible").last().data("index"),f=d.eq(e).nextAll(":not(.disabled):visible").eq(0).data("index"),i=d.eq(e).prevAll(":not(.disabled):visible").eq(0).data("index"),j=d.eq(f).prevAll(":not(.disabled):visible").eq(0).data("index")),k=m.data("prevIndex"),38==b.keyCode&&(o.options.liveSearch&&(e-=1),e!=j&&e>i&&(e=i),g>e&&(e=g),e==k&&(e=h)),40==b.keyCode&&(o.options.liveSearch&&(e+=1),-1==e&&(e=0),e!=j&&f>e&&(e=f),e>h&&(e=h),e==k&&(e=g)),m.data("prevIndex",e),o.options.liveSearch?(b.preventDefault(),m.is(".dropdown-toggle")||(d.removeClass("active"),d.eq(e).addClass("active").find("a").focus(),m.focus())):d.eq(e).focus();else if(!m.is("input")){var q,r,s=[];d.each(function(){a(this).parent().is(":not(.disabled)")&&a.trim(a(this).text().toLowerCase()).substring(0,1)==p[b.keyCode]&&s.push(a(this).parent().index())}),q=a(document).data("keycount"),q++,a(document).data("keycount",q),r=a.trim(a(":focus").text().toLowerCase()).substring(0,1),r!=p[b.keyCode]?(q=1,a(document).data("keycount",q)):q>=s.length&&(a(document).data("keycount",0),q>s.length&&(q=1)),d.eq(s[q-1]).focus()}(/(13|32)/.test(b.keyCode.toString(10))||/(^9$)/.test(b.keyCode.toString(10))&&o.options.selectOnTab)&&l&&(/(32)/.test(b.keyCode.toString(10))||b.preventDefault(),o.options.liveSearch?/(32)/.test(b.keyCode.toString(10))||(o.$menu.find(".active a").click(),m.focus()):a(":focus").click(),a(document).data("keycount",0)),(/(^9$|27)/.test(b.keyCode.toString(10))&&l&&(o.multiple||o.options.liveSearch)||/(27)/.test(b.keyCode.toString(10))&&!l)&&(o.$menu.parent().removeClass("open"),o.$button.focus())}},mobile:function(){this.$element.addClass("mobile-device").appendTo(this.$newElement),this.options.container&&this.$menu.hide()},refresh:function(){this.$lis=null,this.reloadLi(),this.render(),this.setWidth(),this.setStyle(),this.checkDisabled(),this.liHeight()},update:function(){this.reloadLi(),this.setWidth(),this.setStyle(),this.checkDisabled(),this.liHeight()},hide:function(){this.$newElement.hide()},show:function(){this.$newElement.show()},remove:function(){this.$newElement.remove(),this.$element.remove()}};var g=a.fn.selectpicker;a.fn.selectpicker=e,a.fn.selectpicker.Constructor=f,a.fn.selectpicker.noConflict=function(){return a.fn.selectpicker=g,this},a(document).data("keycount",0).on("keydown",".bootstrap-select [data-toggle=dropdown], .bootstrap-select [role=menu], .bs-searchbox input",f.prototype.keydown).on("focusin.modal",".bootstrap-select [data-toggle=dropdown], .bootstrap-select [role=menu], .bs-searchbox input",function(a){a.stopPropagation()}),a(window).on("load.bs.select.data-api",function(){a(".selectpicker").each(function(){var b=a(this);e.call(b,b.data())})})}(jQuery); +//# sourceMappingURL=bootstrap-select.js.map \ No newline at end of file diff --git a/docs/express/CookieOptions.html b/docs/express/CookieOptions.html index 46e807e..91f3e51 100644 --- a/docs/express/CookieOptions.html +++ b/docs/express/CookieOptions.html @@ -1,2 +1,2 @@ -express.CookieOptions - Express Externs and Middleware for Haxe

    package express

    typedef express.CookieOptions

    defined in express.Response

    Available on all platforms

    Properties

    signed:Null<Bool>

    secure:Null<Bool>

    path:Null<String>

    maxAge:Null<String>

    httpOnly:Null<Bool>

    expires:Null<Date>

    domain:Null<String>

    \ No newline at end of file +express.CookieOptions - Express Externs and Middleware for Haxe

    package express

    typedef express.CookieOptions

    defined in express.Response

    Properties

    domain :Null<String>

    expires :Null<Date>

    httpOnly :Null<Bool>

    maxAge :Null<String>

    path :Null<String>

    secure :Null<Bool>

    signed :Null<Bool>

    \ No newline at end of file diff --git a/docs/express/DotFile.html b/docs/express/DotFile.html index 402d23b..27f7916 100644 --- a/docs/express/DotFile.html +++ b/docs/express/DotFile.html @@ -1,2 +1,2 @@ -express.DotFile - Express Externs and Middleware for Haxe

    package express

    abstract express.DotFile(String)

    to String

    defined in express.StaticOptions

    Available on all platforms

    Properties

    read only allow:DotFile

    read only deny:DotFile

    read only ignore:DotFile

    \ No newline at end of file +express.DotFile - Express Externs and Middleware for Haxe

    package express

    abstract express.DotFile(String)

    to String

    defined in express.StaticOptions

    Properties

    read only allow :DotFile

    read only deny :DotFile

    read only ignore :DotFile

    \ No newline at end of file diff --git a/docs/express/EitherMiddleware.html b/docs/express/EitherMiddleware.html new file mode 100644 index 0000000..7b8aef2 --- /dev/null +++ b/docs/express/EitherMiddleware.html @@ -0,0 +1,2 @@ + +express.EitherMiddleware - Express Externs and Middleware for Haxe

    package express

    typedef express.EitherMiddleware

    alias for EitherType<Middleware, ErrorMiddleware>

    defined in express.Middleware

    \ No newline at end of file diff --git a/docs/express/Error.html b/docs/express/Error.html index f878a0e..a5da7c9 100644 --- a/docs/express/Error.html +++ b/docs/express/Error.html @@ -1,2 +1,2 @@ -express.Error - Express Externs and Middleware for Haxe

    package express

    class express.Error

    extends Error

    Available on all platforms

    Properties

    status:Int

    \ No newline at end of file +express.Error - Express Externs and Middleware for Haxe

    package express

    class express.Error

    extends Error

    Properties

    status :Int

    \ No newline at end of file diff --git a/docs/express/ErrorMiddleware.html b/docs/express/ErrorMiddleware.html index 3905e1d..febe86f 100644 --- a/docs/express/ErrorMiddleware.html +++ b/docs/express/ErrorMiddleware.html @@ -1,2 +1,2 @@ -express.ErrorMiddleware - Express Externs and Middleware for Haxe

    package express

    abstract express.ErrorMiddleware(Dynamic)

    from FErrorMiddlewareNext

    from FErrorMiddleware

    to FErrorMiddlewareNext

    to FErrorMiddleware

    defined in express.Middleware

    Available on all platforms

    \ No newline at end of file +express.ErrorMiddleware - Express Externs and Middleware for Haxe

    package express

    abstract express.ErrorMiddleware(Dynamic)

    from FErrorMiddleware

    from FErrorMiddlewareNext

    to FErrorMiddleware

    to FErrorMiddlewareNext

    defined in express.Middleware

    \ No newline at end of file diff --git a/docs/express/Express.html b/docs/express/Express.html index 2a51c37..1afe882 100644 --- a/docs/express/Express.html +++ b/docs/express/Express.html @@ -1,2 +1,2 @@ -express.Express - Express Externs and Middleware for Haxe

    package express

    class express.Express

    extends Route

    Available on all platforms

    Constructor

    new ()

    Properties

    read only locals:{}

    read only mountpath:Array<String>

    Methods

    disable (name:String):Void

    disabled (name:String):Bool

    enable (name:String):Void

    enabled (name:String):Bool

    engine (ext:String, callback:String -> {} -> Error -> String -> Void -> Void):Express

    listen (port:Int, ?hostname:String, ?backlog:Int, ?callback:Void -> Void):Void

    on (event:ExpressEvent, callback:Express -> Void):Void

    param (?name:String, callback:Request -> Response -> Next -> String -> Void):Express

    path ():String

    render (view:String, ?locals:{}, callback:Error -> String -> Void):Void

    route (path:String):Route

    search (path:String, callback:Middleware, callbacks:Rest<Middleware>):Void

    set (name:String, value:Dynamic):Express

    use (path:String, callback:Middleware, callbacks:Rest<Middleware>):Express

    use (callback:Middleware):Express

    use (callback:ErrorMiddleware):Express

    use (app:Express):Express

    use (path:String, app:Express):Express

    use (router:Router):Express

    use (path:String, router:Router):Express

    Static methods

    static serveStatic (root:String, ?options:StaticOptions):Middleware

    \ No newline at end of file +express.Express - Express Externs and Middleware for Haxe

    package express

    class express.Express

    extends Route

    Constructor

    new ()

    Properties

    read only locals :{}

    read only mountpath :Array<String>

    Methods

    disable (name :String) :Void

    disabled (name :String) :Bool

    enable (name :String) :Void

    enabled (name :String) :Bool

    engine (ext :String, callback :String -> {} -> Error -> String -> Void -> Void) :Express

    listen (port :Int, ?hostname :String, ?backlog :Int, ?callback :Void -> Void) :Void

    on (event :ExpressEvent, callback :Express -> Void) :Void

    param (?name :String, callback :Request -> Response -> Next -> String -> Void) :Express

    path () :String

    render (view :String, ?locals :{}, callback :Error -> String -> Void) :Void

    route (path :String) :Route

    search (path :String, callback :Middleware, callbacks :Rest<Middleware>) :Void

    set (name :String, value :Dynamic) :Express

    use (path :String, callback :EitherMiddleware, callbacks :Rest<Middleware>) :Express

    use (callback :EitherMiddleware) :Express

    use (app :Express) :Express

    use (path :String, app :Express) :Express

    use (router :Router) :Express

    use (path :String, router :Router) :Express

    Static methods

    static json (?options :Null<JsonOptions>) :Middleware

    static serveStatic (root :String, ?options :Null<StaticOptions>) :Middleware

    \ No newline at end of file diff --git a/docs/express/ExpressEvent.html b/docs/express/ExpressEvent.html index 6a8c501..26061d7 100644 --- a/docs/express/ExpressEvent.html +++ b/docs/express/ExpressEvent.html @@ -1,2 +1,2 @@ -express.ExpressEvent - Express Externs and Middleware for Haxe

    package express

    abstract express.ExpressEvent(String)

    from String

    to String

    defined in express.Express

    Available on all platforms

    Properties

    read only mount:ExpressEvent

    \ No newline at end of file +express.ExpressEvent - Express Externs and Middleware for Haxe

    package express

    abstract express.ExpressEvent(String)

    from String

    to String

    defined in express.Express

    Properties

    read only mount :ExpressEvent

    \ No newline at end of file diff --git a/docs/express/FErrorMiddleware.html b/docs/express/FErrorMiddleware.html index 04c2b4f..b398385 100644 --- a/docs/express/FErrorMiddleware.html +++ b/docs/express/FErrorMiddleware.html @@ -1,2 +1,2 @@ -express.FErrorMiddleware - Express Externs and Middleware for Haxe

    package express

    typedef express.FErrorMiddleware

    alias for Error -> Request -> Response -> Void

    defined in express.Middleware

    Available on all platforms

    \ No newline at end of file +express.FErrorMiddleware - Express Externs and Middleware for Haxe

    package express

    typedef express.FErrorMiddleware

    alias for Error -> Request -> Response -> Void

    defined in express.Middleware

    \ No newline at end of file diff --git a/docs/express/FErrorMiddlewareNext.html b/docs/express/FErrorMiddlewareNext.html index eb1cec3..ceea53e 100644 --- a/docs/express/FErrorMiddlewareNext.html +++ b/docs/express/FErrorMiddlewareNext.html @@ -1,2 +1,2 @@ -express.FErrorMiddlewareNext - Express Externs and Middleware for Haxe

    package express

    typedef express.FErrorMiddlewareNext

    alias for Error -> Request -> Response -> Next -> Void

    defined in express.Middleware

    Available on all platforms

    \ No newline at end of file +express.FErrorMiddlewareNext - Express Externs and Middleware for Haxe

    package express

    typedef express.FErrorMiddlewareNext

    alias for Error -> Request -> Response -> Next -> Void

    defined in express.Middleware

    \ No newline at end of file diff --git a/docs/express/FMiddleware.html b/docs/express/FMiddleware.html index 47bae3b..f455d8e 100644 --- a/docs/express/FMiddleware.html +++ b/docs/express/FMiddleware.html @@ -1,2 +1,2 @@ -express.FMiddleware - Express Externs and Middleware for Haxe

    package express

    typedef express.FMiddleware

    alias for Request -> Response -> Void

    defined in express.Middleware

    Available on all platforms

    \ No newline at end of file +express.FMiddleware - Express Externs and Middleware for Haxe

    package express

    typedef express.FMiddleware

    alias for Request -> Response -> Void

    defined in express.Middleware

    \ No newline at end of file diff --git a/docs/express/FMiddlewareNext.html b/docs/express/FMiddlewareNext.html index 1617084..eb465ac 100644 --- a/docs/express/FMiddlewareNext.html +++ b/docs/express/FMiddlewareNext.html @@ -1,2 +1,2 @@ -express.FMiddlewareNext - Express Externs and Middleware for Haxe

    package express

    typedef express.FMiddlewareNext

    alias for Request -> Response -> Next -> Void

    defined in express.Middleware

    Available on all platforms

    \ No newline at end of file +express.FMiddlewareNext - Express Externs and Middleware for Haxe

    package express

    typedef express.FMiddlewareNext

    alias for Request -> Response -> Next -> Void

    defined in express.Middleware

    \ No newline at end of file diff --git a/docs/express/FNext.html b/docs/express/FNext.html index 9c34b0f..91e4902 100644 --- a/docs/express/FNext.html +++ b/docs/express/FNext.html @@ -1,2 +1,2 @@ -express.FNext - Express Externs and Middleware for Haxe

    package express

    typedef express.FNext

    alias for Void -> Void

    defined in express.Next

    Available on all platforms

    \ No newline at end of file +express.FNext - Express Externs and Middleware for Haxe

    package express

    typedef express.FNext

    alias for Void -> Void

    defined in express.Next

    \ No newline at end of file diff --git a/docs/express/FNextError.html b/docs/express/FNextError.html index a21dc84..678e407 100644 --- a/docs/express/FNextError.html +++ b/docs/express/FNextError.html @@ -1,2 +1,2 @@ -express.FNextError - Express Externs and Middleware for Haxe

    package express

    typedef express.FNextError

    alias for Error -> Void

    defined in express.Next

    Available on all platforms

    \ No newline at end of file +express.FNextError - Express Externs and Middleware for Haxe

    package express

    typedef express.FNextError

    alias for Error -> Void

    defined in express.Next

    \ No newline at end of file diff --git a/docs/express/FNextRoute.html b/docs/express/FNextRoute.html index a4244e0..f515553 100644 --- a/docs/express/FNextRoute.html +++ b/docs/express/FNextRoute.html @@ -1,2 +1,2 @@ -express.FNextRoute - Express Externs and Middleware for Haxe

    package express

    typedef express.FNextRoute

    alias for String -> Void

    defined in express.Next

    Available on all platforms

    \ No newline at end of file +express.FNextRoute - Express Externs and Middleware for Haxe

    package express

    typedef express.FNextRoute

    alias for String -> Void

    defined in express.Next

    \ No newline at end of file diff --git a/docs/express/Middleware.html b/docs/express/Middleware.html index e6b49df..8351b2d 100644 --- a/docs/express/Middleware.html +++ b/docs/express/Middleware.html @@ -1,2 +1,2 @@ -express.Middleware - Express Externs and Middleware for Haxe

    package express

    abstract express.Middleware(Dynamic)

    from FMiddlewareNext

    from FMiddleware

    to FMiddlewareNext

    to FMiddleware

    Available on all platforms

    \ No newline at end of file +express.Middleware - Express Externs and Middleware for Haxe

    package express

    abstract express.Middleware(Dynamic)

    from FMiddleware

    from FMiddlewareNext

    to FMiddleware

    to FMiddlewareNext

    \ No newline at end of file diff --git a/docs/express/Next.html b/docs/express/Next.html index 7a9f837..6550eff 100644 --- a/docs/express/Next.html +++ b/docs/express/Next.html @@ -1,2 +1,2 @@ -express.Next - Express Externs and Middleware for Haxe

    package express

    abstract express.Next(Dynamic)

    from FNextError

    from FNextRoute

    from FNext

    to FNextError

    to FNextRoute

    to FNext

    Available on all platforms

    Methods

    call ():Void

    error (err:Error):Void

    route ():Void

    \ No newline at end of file +express.Next - Express Externs and Middleware for Haxe

    package express

    abstract express.Next(Dynamic)

    from FNext

    from FNextRoute

    from FNextError

    to FNext

    to FNextRoute

    to FNextError

    Static methods

    static call (this :Dynamic) :Void

    static error (this :Dynamic, err :Error) :Void

    static route (this :Dynamic) :Void

    \ No newline at end of file diff --git a/docs/express/Request.html b/docs/express/Request.html index 305fe8d..a347b6f 100644 --- a/docs/express/Request.html +++ b/docs/express/Request.html @@ -1,2 +1,2 @@ -express.Request - Express Externs and Middleware for Haxe

    package express

    class express.Request

    extends IncomingMessage

    Available on all platforms

    Properties

    app:Express

    baseUrl:String

    body:{}

    fresh:Bool

    hostname:String

    ip:String

    ips:Array<String>

    originUrl:String

    params:{}

    path:String

    protocol:String

    query:{}

    route:String

    secure:Bool

    stale:Bool

    subdomains:Array<String>

    xhr:Bool

    Methods

    accepts (type:String):String

    accepts (types:Array<String>):String

    acceptsCharsets (charset:String, charsets:Rest<String>):String

    acceptsEncodings (encoding:String, encodings:Rest<String>):String

    acceptsLanguages (languageg:String, languages:Rest<String>):String

    get (field:String):String

    is (type:String):EitherType<String, Bool>

    is (types:Array<String>):EitherType<String, Bool>

    param (name:String, ?defaultValue:String):String

    \ No newline at end of file +express.Request - Express Externs and Middleware for Haxe

    package express

    class express.Request

    extends IncomingMessage

    Properties

    app :Express

    baseUrl :String

    body :{}

    fresh :Bool

    hostname :String

    ip :String

    ips :Array<String>

    originalUrl :String

    params :{}

    path :String

    protocol :String

    query :{}

    route :String

    secure :Bool

    stale :Bool

    subdomains :Array<String>

    xhr :Bool

    Methods

    accepts (type :String) :String

    accepts (types :Array<String>) :String

    acceptsCharsets (charset :String, charsets :Rest<String>) :String

    acceptsEncodings (encoding :String, encodings :Rest<String>) :String

    acceptsLanguages (languageg :String, languages :Rest<String>) :String

    get (field :String) :String

    is (type :String) :EitherType<String, Bool>

    is (types :Array<String>) :EitherType<String, Bool>

    param (name :String, ?defaultValue :String) :String

    \ No newline at end of file diff --git a/docs/express/Response.html b/docs/express/Response.html index 3b35116..9b05b60 100644 --- a/docs/express/Response.html +++ b/docs/express/Response.html @@ -1,2 +1,2 @@ -express.Response - Express Externs and Middleware for Haxe

    package express

    class express.Response

    extends ServerResponse

    Available on all platforms

    Properties

    app:Express

    headersSend:Bool

    locals:{}

    Methods

    append (field:String, value:String):Response

    append (field:String, values:Array<String>):Void

    attachment (?filename:String):Response

    clearCookie (name:String, ?options:CookieOptions):Response

    cookie (name:String, value:String, ?options:CookieOptions):Response

    download (path:String, ?filename:String, ?callback:Error -> Void):Void

    format (object:Dynamic<Void -> Void>):Response

    get (field:String):String

    json (body:{}):Response

    json (body:Int):Void

    json (body:Float):Void

    json (body:String):Void

    json (body:Array<Dynamic>):Void

    jsonp (body:{}):Response

    jsonp (body:Int):Void

    jsonp (body:Float):Void

    jsonp (body:String):Void

    jsonp (body:Array<Dynamic>):Void

    links (links:Dynamic<String>):Void

    location (path:String):Response

    redirect (?status:Int, path:String):Void

    render (view:String, ?locals:{}, ?callback:Error -> String -> Void):Void

    send (body:{}):Response

    send (body:Buffer):Void

    send (body:String):Void

    send (body:Array<Dynamic>):Void

    sendFile (path:String, ?options:SendFileOptions, ?callback:Error -> Void):Void

    sendStatus (statusCode:Int):Response

    set (body:Dynamic<String>):Response

    set (field:String, value:String):Response

    status (statusCode:Int):Response

    type (type:String):String

    vary (field:String):Response

    \ No newline at end of file +express.Response - Express Externs and Middleware for Haxe

    package express

    class express.Response

    extends ServerResponse

    Properties

    app :Express

    headersSend :Bool

    locals :{}

    Methods

    append (field :String, value :String) :Response

    append (field :String, values :Array<String>) :Void

    attachment (?filename :String) :Response

    clearCookie (name :String, ?options :Null<CookieOptions>) :Response

    cookie (name :String, value :String, ?options :Null<CookieOptions>) :Response

    download (path :String, ?filename :String, ?callback :Error -> Void) :Void

    format (object :Dynamic<Void -> Void>) :Response

    get (field :String) :String

    json (body :{}) :Response

    json (body :Int) :Void

    json (body :Float) :Void

    json (body :String) :Void

    json (body :Array<Dynamic>) :Void

    jsonp (body :{}) :Response

    jsonp (body :Int) :Void

    jsonp (body :Float) :Void

    jsonp (body :String) :Void

    jsonp (body :Array<Dynamic>) :Void

    links (links :Dynamic<String>) :Void

    location (path :String) :Response

    redirect (path :String) :Void

    redirect (status :Int, path :String) :Void

    render (view :String, ?locals :{}, ?callback :Error -> String -> Void) :Void

    send (body :{}) :Response

    send (body :Buffer) :Void

    send (body :String) :Void

    send (body :Array<Dynamic>) :Void

    sendFile (path :String, ?options :Null<SendFileOptions>, ?callback :Error -> Void) :Void

    sendStatus (statusCode :Int) :Response

    set (body :Dynamic<String>) :Response

    set (field :String, value :String) :Response

    status (statusCode :Int) :Response

    type (type :String) :String

    vary (field :String) :Response

    \ No newline at end of file diff --git a/docs/express/Route.html b/docs/express/Route.html index 66f8dc7..32ec6f1 100644 --- a/docs/express/Route.html +++ b/docs/express/Route.html @@ -1,2 +1,2 @@ -express.Route - Express Externs and Middleware for Haxe

    package express

    class express.Route

    Available on all platforms

    extended by Express, Router

    Methods

    all (path:String, callback:Middleware, callbacks:Rest<Middleware>):Void

    checkout (path:String, callback:Middleware, callbacks:Rest<Middleware>):Void

    connect (path:String, callback:Middleware, callbacks:Rest<Middleware>):Void

    copy (path:String, callback:Middleware, callbacks:Rest<Middleware>):Void

    delete (path:String, callback:Middleware, callbacks:Rest<Middleware>):Void

    get (path:String, callback:Middleware, callbacks:Rest<Middleware>):Void

    head (path:String, callback:Middleware, callbacks:Rest<Middleware>):Void

    lock (path:String, callback:Middleware, callbacks:Rest<Middleware>):Void

    merge (path:String, callback:Middleware, callbacks:Rest<Middleware>):Void

    mkactivity (path:String, callback:Middleware, callbacks:Rest<Middleware>):Void

    mkcol (path:String, callback:Middleware, callbacks:Rest<Middleware>):Void

    move (path:String, callback:Middleware, callbacks:Rest<Middleware>):Void

    notify (path:String, callback:Middleware, callbacks:Rest<Middleware>):Void

    options (path:String, callback:Middleware, callbacks:Rest<Middleware>):Void

    patch (path:String, callback:Middleware, callbacks:Rest<Middleware>):Void

    post (path:String, callback:Middleware, callbacks:Rest<Middleware>):Void

    propfind (path:String, callback:Middleware, callbacks:Rest<Middleware>):Void

    proppatch (path:String, callback:Middleware, callbacks:Rest<Middleware>):Void

    purge (path:String, callback:Middleware, callbacks:Rest<Middleware>):Void

    put (path:String, callback:Middleware, callbacks:Rest<Middleware>):Void

    report (path:String, callback:Middleware, callbacks:Rest<Middleware>):Void

    subscribe (path:String, callback:Middleware, callbacks:Rest<Middleware>):Void

    trace (path:String, callback:Middleware, callbacks:Rest<Middleware>):Void

    unlock (path:String, callback:Middleware, callbacks:Rest<Middleware>):Void

    unsubscribe (path:String, callback:Middleware, callbacks:Rest<Middleware>):Void

    \ No newline at end of file +express.Route - Express Externs and Middleware for Haxe

    package express

    class express.Route

    extended by Express, Router

    Methods

    all (path :String, callback :Middleware, callbacks :Rest<Middleware>) :Void

    checkout (path :String, callback :Middleware, callbacks :Rest<Middleware>) :Void

    connect (path :String, callback :Middleware, callbacks :Rest<Middleware>) :Void

    copy (path :String, callback :Middleware, callbacks :Rest<Middleware>) :Void

    delete (path :String, callback :Middleware, callbacks :Rest<Middleware>) :Void

    get (path :String, callback :Middleware, callbacks :Rest<Middleware>) :Void

    head (path :String, callback :Middleware, callbacks :Rest<Middleware>) :Void

    lock (path :String, callback :Middleware, callbacks :Rest<Middleware>) :Void

    merge (path :String, callback :Middleware, callbacks :Rest<Middleware>) :Void

    mkactivity (path :String, callback :Middleware, callbacks :Rest<Middleware>) :Void

    mkcol (path :String, callback :Middleware, callbacks :Rest<Middleware>) :Void

    move (path :String, callback :Middleware, callbacks :Rest<Middleware>) :Void

    notify (path :String, callback :Middleware, callbacks :Rest<Middleware>) :Void

    options (path :String, callback :Middleware, callbacks :Rest<Middleware>) :Void

    patch (path :String, callback :Middleware, callbacks :Rest<Middleware>) :Void

    post (path :String, callback :Middleware, callbacks :Rest<Middleware>) :Void

    propfind (path :String, callback :Middleware, callbacks :Rest<Middleware>) :Void

    proppatch (path :String, callback :Middleware, callbacks :Rest<Middleware>) :Void

    purge (path :String, callback :Middleware, callbacks :Rest<Middleware>) :Void

    put (path :String, callback :Middleware, callbacks :Rest<Middleware>) :Void

    report (path :String, callback :Middleware, callbacks :Rest<Middleware>) :Void

    subscribe (path :String, callback :Middleware, callbacks :Rest<Middleware>) :Void

    trace (path :String, callback :Middleware, callbacks :Rest<Middleware>) :Void

    unlock (path :String, callback :Middleware, callbacks :Rest<Middleware>) :Void

    unsubscribe (path :String, callback :Middleware, callbacks :Rest<Middleware>) :Void

    \ No newline at end of file diff --git a/docs/express/Router.html b/docs/express/Router.html index 4e314b9..6033d4b 100644 --- a/docs/express/Router.html +++ b/docs/express/Router.html @@ -1,2 +1,2 @@ -express.Router - Express Externs and Middleware for Haxe

    package express

    class express.Router

    extends Route

    Available on all platforms

    Constructor

    new (?options:RouterOptions)

    Methods

    param (?name:String, callback:Request -> Response -> Next -> String -> Void):Void

    path ():String

    use (path:String, callback:Middleware, callbacks:Rest<Middleware>):Router

    use (callback:Middleware):Router

    use (callback:ErrorMiddleware):Router

    use (router:Router):Router

    use (path:String, router:Router):Router

    \ No newline at end of file +express.Router - Express Externs and Middleware for Haxe

    package express

    class express.Router

    extends Route

    Constructor

    new (?options :Null<RouterOptions>)

    Methods

    param (?name :String, callback :Request -> Response -> Next -> String -> Void) :Void

    path () :String

    use (path :String, callback :EitherMiddleware, callbacks :Rest<Middleware>) :Router

    use (callback :EitherMiddleware) :Router

    use (router :Router) :Router

    use (path :String, router :Router) :Router

    \ No newline at end of file diff --git a/docs/express/RouterOptions.html b/docs/express/RouterOptions.html index 2ada387..9d4d0cb 100644 --- a/docs/express/RouterOptions.html +++ b/docs/express/RouterOptions.html @@ -1,2 +1,2 @@ -express.RouterOptions - Express Externs and Middleware for Haxe

    package express

    typedef express.RouterOptions

    defined in express.Router

    Available on all platforms

    Properties

    strict:Null<Bool>

    mergeParams:Null<Bool>

    caseSensitive:Null<Bool>

    \ No newline at end of file +express.RouterOptions - Express Externs and Middleware for Haxe

    package express

    typedef express.RouterOptions

    defined in express.Router

    Properties

    caseSensitive :Null<Bool>

    mergeParams :Null<Bool>

    strict :Null<Bool>

    \ No newline at end of file diff --git a/docs/express/SendFileOptions.html b/docs/express/SendFileOptions.html index 77ca608..6507107 100644 --- a/docs/express/SendFileOptions.html +++ b/docs/express/SendFileOptions.html @@ -1,2 +1,2 @@ -express.SendFileOptions - Express Externs and Middleware for Haxe

    package express

    typedef express.SendFileOptions

    defined in express.Response

    Available on all platforms

    Properties

    root:Null<String>

    maxAge:Null<String>

    lastModified:Null<String>

    headers:Null<Dynamic<String>>

    dotfiles:Null<String>

    \ No newline at end of file +express.SendFileOptions - Express Externs and Middleware for Haxe

    package express

    typedef express.SendFileOptions

    defined in express.Response

    Properties

    dotfiles :Null<String>

    headers :Null<Dynamic<String>>

    lastModified :Null<String>

    maxAge :Null<String>

    root :Null<String>

    \ No newline at end of file diff --git a/docs/express/StaticOptions.html b/docs/express/StaticOptions.html index b16873c..117dd7b 100644 --- a/docs/express/StaticOptions.html +++ b/docs/express/StaticOptions.html @@ -1,2 +1,2 @@ -express.StaticOptions - Express Externs and Middleware for Haxe

    package express

    typedef express.StaticOptions

    Available on all platforms

    Properties

    setHeaders:Null<Response -> String -> Stats -> Void>

    redirect:Null<Bool>

    maxAge:Null<EitherType<String, Float>>

    lastModified:Null<Bool>

    index:Null<EitherType<Bool, EitherType<String, Array<String>>>>

    extensions:Null<EitherType<Bool, Array<String>>>

    etag:Null<Bool>

    dotfiles:Null<DotFile>

    \ No newline at end of file +express.StaticOptions - Express Externs and Middleware for Haxe

    package express

    typedef express.StaticOptions

    Properties

    dotfiles :Null<DotFile>

    etag :Null<Bool>

    extensions :Null<EitherType<Bool, Array<String>>>

    index :Null<EitherType<Bool, EitherType<String, Array<String>>>>

    lastModified :Null<Bool>

    maxAge :Null<EitherType<String, Float>>

    redirect :Null<Bool>

    setHeaders :Null<Response -> String -> Stats -> Void>

    \ No newline at end of file diff --git a/docs/express/index.html b/docs/express/index.html index ca33d3a..6e10491 100644 --- a/docs/express/index.html +++ b/docs/express/index.html @@ -1,2 +1,2 @@ -express - Express Externs and Middleware for Haxe

    package express

    CookieOptions

    DotFile

    Error

    ErrorMiddleware

    Express

    ExpressEvent

    FErrorMiddleware

    FErrorMiddlewareNext

    FMiddleware

    FMiddlewareNext

    FNext

    FNextError

    FNextRoute

    Middleware

    Next

    Request

    Response

    Route

    Router

    RouterOptions

    SendFileOptions

    StaticOptions

    \ No newline at end of file +express - Express Externs and Middleware for Haxe

    package express

    CookieOptions

    DotFile

    EitherMiddleware

    Error

    ErrorMiddleware

    Express

    ExpressEvent

    FErrorMiddleware

    FErrorMiddlewareNext

    FMiddleware

    FMiddlewareNext

    FNext

    FNextError

    FNextRoute

    Middleware

    Next

    Request

    Response

    Route

    Router

    RouterOptions

    SendFileOptions

    StaticOptions

    \ No newline at end of file diff --git a/docs/extra-styles.css b/docs/extra-styles.css new file mode 100644 index 0000000..1376552 --- /dev/null +++ b/docs/extra-styles.css @@ -0,0 +1 @@ +/** to be overridden in sub-themes */ \ No newline at end of file diff --git a/docs/haxe-nav.css b/docs/haxe-nav.css new file mode 100644 index 0000000..431c457 --- /dev/null +++ b/docs/haxe-nav.css @@ -0,0 +1,189 @@ +nav.nav { + font-family: "Open Sans", sans-serif; + font-size: 16px; + margin: 0; +} + +nav .fa { + color: #777; + margin-right: 5px; +} + +body nav * { + line-height: 20px; +} + +nav .navbar-inner { + background: #13110f; + border: 0; + border-radius: 0; +} + +nav .navbar .nav { + margin: 0; + +} + +nav .dropdown-menu { + background: #2c2722; + font-size: 14px; + border-radius: 0px 0px 2px 2px; + padding: 10px 0px; + border: 1px solid #2c2722; + margin-top: -1px; +} + +nav .navbar .nav>li>a { + padding: 14px 12px 15px 12px; + color: #ccc; +} + +nav .dropdown-menu li a { + color: #b8b5b5; + padding: 3px 15px; +} + +nav .divider { + background-color: transparent; + border-right: 1px solid #39332d; + margin: 5px 20px 5px 10px; + height: 39px; +} + +nav .dropdown-menu .divider { + background-color: transparent; + border: 0; + border-bottom: 1px solid #39332d; + margin: 5px 0; +} + +nav .navbar-inverse .nav .active>a, +nav .navbar-inverse .nav .active>a:hover, +nav .navbar-inverse .nav .active>a:focus, +nav .navbar-inverse .nav li.dropdown.open>.dropdown-toggle, +nav .navbar-inverse .nav li.dropdown.active>.dropdown-toggle, +nav .navbar-inverse .nav li.dropdown.open.active>.dropdown-toggle { + color: #fff; + background-color: transparent; + background-image: none; +} + +nav .navbar-inverse .nav .active>a:hover { + background: #39332d; +} + +nav .dropdown-menu>.active>a, +nav .dropdown-menu>.active>a:hover, +nav .dropdown-menu>.active>a:focus { + font-weight: bold; + color: #fff; + background-image: none; + background: #39332d; +} + +nav .dropdown-menu>li>a:hover, +.dropdown-menu>li>a:focus, +nav .dropdown-submenu:hover>a, +nav .dropdown-submenu:focus>a { + background: #39332d; +} + +nav .navbar .nav>li>.dropdown-menu:after { + border-bottom-color: #2c2722; +} + +/** MEDIA Q **/ + +@media (max-width: 979px) { + + nav .navbar-fixed-top .navbar-inner, + nav .navbar-fixed-bottom .navbar-inner { + padding: 0px; + } + + nav .navbar-fixed-top { + margin-bottom: 0; + } +} + +/** SUB BRAND LOGOS **/ + +.navbar .brand.haxe-logo { + padding-right: 0; + margin: 3px 0 0 0px; +} + +.navbar .brand.haxe-logo:hover { + opacity: .9; +} + +.navbar .brand.haxe-logo:after { + content: " "; + position: absolute; + /* create arrow */ + width: 0; + height: 0; + border-top: 22px solid transparent; + border-bottom: 22px solid transparent; + border-left: 7px solid #13110f; + /* same color as nav bar */ + top: 0; +} + +.navbar .brand.sub { + background: #39332d; + /* Old browsers */ + background: -moz-linear-gradient(top, #39332d 50%, #2c2722 51%); + /* FF3.6+ */ + background: -webkit-gradient(linear, left top, left bottom, color-stop(50%, #39332d), color-stop(51%, #2c2722)); + /* Chrome,Safari4+ */ + background: -webkit-linear-gradient(top, #39332d 50%, #2c2722 51%); + /* Chrome10+,Safari5.1+ */ + background: -o-linear-gradient(top, #39332d 50%, #2c2722 51%); + /* Opera 11.10+ */ + background: -ms-linear-gradient(top, #39332d 50%, #2c2722 51%); + /* IE10+ */ + background: linear-gradient(to bottom, #39332d 50%, #2c2722 51%); + /* W3C */ + padding: 14px 20px 13px 20px; + margin: 0 10px 0 0; + font: bold 18px "arial black", "open sans"; + line-height: 22px; + color: rgb(255, 255, 255); +} + +.navbar .brand.sub:hover { + color: rgb(230, 230, 230); + background: #2c2722; + /* Old browsers */ +} + +.navbar .brand.sub:before { + content: ".."; + /* two dots */ + position: absolute; + margin-left: -33px; + margin-top: -28px; + line-height: 0px; + font: bold 40px "Open Sans", sans-serif; + letter-spacing: 0px; + color: #fff200; +} + +/** SUB BRAND COLORS **/ + +.navbar .brand.sub.try:before { + color: #f89c0e; +} + +.navbar .brand.sub.api:before { + color: #eedc16; +} + +.navbar .brand.sub.lib:before { + color: #f1471d; +} + +.navbar .brand.sub.ide:before { + color: #f89c0e; +} \ No newline at end of file diff --git a/docs/highlighter.css b/docs/highlighter.css new file mode 100644 index 0000000..1e8a8b7 --- /dev/null +++ b/docs/highlighter.css @@ -0,0 +1,65 @@ +/** + Code Highlighting +**/ +html pre, +html pre code { + font-family: consolas, monospace; + white-space: pre; + overflow-x: auto; +} + +code { + color: #333; +} + +code a { + color: #08c; +} + +pre { + color: #333; + margin: 15px 0; + padding: 0.5em; +} + +pre .type { + color: #0086b3; +} + +pre .kwd { + color: #00a; +} + +pre .val { + color: #44a; +} + +pre .str, +div.pre .str, +pre .str .kwd, +pre .str .val, +pre .str .type { + color: #a00; +} + +pre .cmt { + color: #008800; + color: #998; + font-style: italic; +} + +/* Make sure keywords inside comments are not highlighted*/ +pre .cmt .kwd, +pre .cmt .str, +pre .cmt .val, +pre .cmt .type { + color: #998; +} + +.last-modified { + color: #999; +} + +.semantic { + display: none; +} \ No newline at end of file diff --git a/docs/highlighter.js b/docs/highlighter.js new file mode 100644 index 0000000..49b6349 --- /dev/null +++ b/docs/highlighter.js @@ -0,0 +1,43 @@ +// highlighter adapted/modified from code.haxe.org +(function (console) { "use strict"; +var EReg = function(r,opt) { + opt = opt.split("u").join(""); + this.r = new RegExp(r,opt); +}; +EReg.prototype = { + replace: function(s,by) { + return s.replace(this.r,by); + } +}; +var Highlighter = function() { }; +Highlighter.main = function() { + var _g = 0; + var _g1 = window.document.body.querySelectorAll("pre code"); + while(_g < _g1.length) { + var el = _g1[_g]; + ++_g; + if(!Highlighter.hasClass(el,"highlighted")) { + el.innerHTML = Highlighter.syntaxHighlight(el.innerHTML); + el.className += " highlighted"; + } + } +}; +Highlighter.hasClass = function(el,className) { + return el.className.indexOf(className) != -1; +}; +Highlighter.syntaxHighlight = function(html) { + var kwds = ["abstract","trace","break","case","cast","class","continue","default","do","dynamic","else","enum","extends","extern","for","function","if","implements","import","in","inline","interface","macro","new","override","package","private","public","return","static","switch","throw","try","typedef","untyped","using","var","while"]; + var kwds1 = new EReg("\\b(" + kwds.join("|") + ")\\b","g"); + var vals = ["null","true","false","this"]; + var vals1 = new EReg("\\b(" + vals.join("|") + ")\\b","g"); + var types = new EReg("\\b([A-Z][a-zA-Z0-9]*)\\b","g"); + html = kwds1.replace(html,"$1"); + html = vals1.replace(html,"$1"); + html = types.replace(html,"$1"); + html = new EReg("(\"[^\"]*\")","g").replace(html,"$1"); + html = new EReg("(//.+?)(\n|$)","g").replace(html,"$1$2"); + html = new EReg("(/\\*\\*?(.|\n)+?\\*?\\*/)","g").replace(html,"$1"); + return html; +}; +Highlighter.main(); +})(typeof console != "undefined" ? console : {log:function(){}}); diff --git a/docs/index.js b/docs/index.js index 597d122..35f4860 100644 --- a/docs/index.js +++ b/docs/index.js @@ -51,17 +51,17 @@ function selectVersion(e) { function setPlatform(platform) { selectItem("platform", platform); - + var styles = ".platform { display:none }"; var platforms = dox.platforms; for (var i = 0; i < platforms.length; i++) { var p = platforms[i]; - + if (platform == "sys") { - if (p != "flash" && p != "js") + if (p != "flash" && p != "flash8" && p != "js") { styles += ".platform-" + p + " { display:inherit } "; } @@ -74,8 +74,8 @@ function setPlatform(platform) { } } } - - if (platform != "flash" && platform != "js") + + if (platform != "flash" && platform != "flash8" && platform != "js") { styles += ".platform-sys { display:inherit } "; } @@ -150,11 +150,11 @@ function searchQuery(query) { }); return; } - + console.log("Searching: "+query); var searchSet = false; - + $("#nav").addClass("searching"); $("#nav li").each(function(index, element){ var e = $(element); @@ -169,7 +169,7 @@ function searchQuery(query) { e.css("display", match ? "" : "none"); } }); - + } function searchMatch(text, query) { diff --git a/docs/mw/BasicAuth.html b/docs/mw/BasicAuth.html new file mode 100644 index 0000000..b599808 --- /dev/null +++ b/docs/mw/BasicAuth.html @@ -0,0 +1,2 @@ + +mw.BasicAuth - Express Externs and Middleware for Haxe

    package mw

    class mw.BasicAuth

    Static methods

    static create (realm :String, authenticator :String -> String -> Request -> Null<Error> -> Void -> Void) :Request -> Response -> Next -> Void

    \ No newline at end of file diff --git a/docs/mw/BearerTokenAuth.html b/docs/mw/BearerTokenAuth.html new file mode 100644 index 0000000..90627d1 --- /dev/null +++ b/docs/mw/BearerTokenAuth.html @@ -0,0 +1,2 @@ + +mw.BearerTokenAuth - Express Externs and Middleware for Haxe

    package mw

    class mw.BearerTokenAuth

    Static methods

    static create (authenticator :String -> Request -> Null<Error> -> Void -> Void) :Request -> Response -> Next -> Void

    \ No newline at end of file diff --git a/docs/mw/BodyParser.html b/docs/mw/BodyParser.html index a30402c..8da556d 100644 --- a/docs/mw/BodyParser.html +++ b/docs/mw/BodyParser.html @@ -1,2 +1,2 @@ -mw.BodyParser - Express Externs and Middleware for Haxe

    package mw

    class mw.BodyParser

    Available on all platforms

    Static methods

    static json (?options:JsonOptions):Middleware

    static raw (?options:RawOptions):Middleware

    static text (?options:TextOptions):Middleware

    static urlencoded (?options:RawOptions):Middleware

    \ No newline at end of file +mw.BodyParser - Express Externs and Middleware for Haxe

    package mw

    class mw.BodyParser

    Static methods

    static json (?options :Null<JsonOptions>) :Middleware

    static raw (?options :Null<RawOptions>) :Middleware

    static text (?options :Null<TextOptions>) :Middleware

    static urlencoded (?options :Null<UrlEncodedOptions>) :Middleware

    \ No newline at end of file diff --git a/docs/mw/Busboy.html b/docs/mw/Busboy.html index 9f6ce16..c8d641e 100644 --- a/docs/mw/Busboy.html +++ b/docs/mw/Busboy.html @@ -1,2 +1,2 @@ -mw.Busboy - Express Externs and Middleware for Haxe

    package mw

    class mw.Busboy

    Available on all platforms

    Static methods

    static create (?options:Options):Middleware

    \ No newline at end of file +mw.Busboy - Express Externs and Middleware for Haxe

    package mw

    class mw.Busboy

    Static methods

    static create (?options :Null<Options>) :Middleware

    \ No newline at end of file diff --git a/docs/mw/Compression.html b/docs/mw/Compression.html index 94da738..04962eb 100644 --- a/docs/mw/Compression.html +++ b/docs/mw/Compression.html @@ -1,2 +1,2 @@ -mw.Compression - Express Externs and Middleware for Haxe

    package mw

    class mw.Compression

    Available on all platforms

    Static methods

    static create (?options:CompressionOptions):Middleware

    \ No newline at end of file +mw.Compression - Express Externs and Middleware for Haxe

    package mw

    class mw.Compression

    Static methods

    static create (?options :Null<CompressionOptions>) :Middleware

    \ No newline at end of file diff --git a/docs/mw/CookieParser.html b/docs/mw/CookieParser.html index 793d168..4c3353f 100644 --- a/docs/mw/CookieParser.html +++ b/docs/mw/CookieParser.html @@ -1,2 +1,2 @@ -mw.CookieParser - Express Externs and Middleware for Haxe

    package mw

    class mw.CookieParser

    Available on all platforms

    Static methods

    static JSONCookie (str:String):Dynamic

    static JSONCookies (cookies:{}):{}

    static create (?secret:String, ?options:{decode:Null<String -> String>}):Middleware

    static signedCookie (str:String, secret:String):Dynamic

    static signedCookies (cookies:{}, secret:String):{}

    \ No newline at end of file +mw.CookieParser - Express Externs and Middleware for Haxe

    package mw

    class mw.CookieParser

    Static methods

    static JSONCookie (str :String) :Dynamic

    static JSONCookies (cookies :{}) :{}

    static create (?secret :String, ?options :{decode:Null<String -> String>}) :Middleware

    static signedCookie (str :String, secret :String) :Dynamic

    static signedCookies (cookies :{}, secret :String) :{}

    \ No newline at end of file diff --git a/docs/mw/CookieSession.html b/docs/mw/CookieSession.html index 7b0a068..d0b350e 100644 --- a/docs/mw/CookieSession.html +++ b/docs/mw/CookieSession.html @@ -1,2 +1,2 @@ -mw.CookieSession - Express Externs and Middleware for Haxe

    package mw

    class mw.CookieSession

    Available on all platforms

    Static methods

    static create (?options:SessionOptions, ?cookieOptions:CookieOptions):Middleware

    \ No newline at end of file +mw.CookieSession - Express Externs and Middleware for Haxe

    package mw

    class mw.CookieSession

    Static methods

    static create (?options :Null<SessionOptions>, ?cookieOptions :Null<CookieOptions>) :Middleware

    \ No newline at end of file diff --git a/docs/mw/Cors.html b/docs/mw/Cors.html index ef5b81d..65b1cb2 100644 --- a/docs/mw/Cors.html +++ b/docs/mw/Cors.html @@ -1,2 +1,2 @@ -mw.Cors - Express Externs and Middleware for Haxe

    package mw

    class mw.Cors

    Available on all platforms

    Static methods

    static create (?options:Options):Middleware

    \ No newline at end of file +mw.Cors - Express Externs and Middleware for Haxe

    package mw

    class mw.Cors

    Static methods

    static create (?options :Null<Options>) :Middleware

    \ No newline at end of file diff --git a/docs/mw/ExpressBrute.html b/docs/mw/ExpressBrute.html new file mode 100644 index 0000000..4eb712b --- /dev/null +++ b/docs/mw/ExpressBrute.html @@ -0,0 +1,2 @@ + +mw.ExpressBrute - Express Externs and Middleware for Haxe

    package mw

    class mw.ExpressBrute

    Constructor

    new (store :Store, ?options :Null<Options>)

    Methods

    getIPFromRequest (req :Request) :String

    getMiddleware (options :MiddlewareOptions) :Middleware

    prevent (req :Request, res :Response, next :Next) :Void

    reset (ip :String, key :String, next :Next) :Void

    Static methods

    static FailForbidden (req :Request, res :Response, next :Next, nextValidRequestDate :Date) :Void

    static FailMark (req :Request, res :Response, next :Next, nextValidRequestDate :Date) :Void

    static FailTooManyRequests (req :Request, res :Response, next :Next, nextValidRequestDate :Date) :Void

    \ No newline at end of file diff --git a/docs/mw/ExpressForceSSL.html b/docs/mw/ExpressForceSSL.html new file mode 100644 index 0000000..98d3623 --- /dev/null +++ b/docs/mw/ExpressForceSSL.html @@ -0,0 +1,2 @@ + +mw.ExpressForceSSL - Express Externs and Middleware for Haxe

    package mw

    class mw.ExpressForceSSL

    Static properties

    static read only instance :Middleware

    \ No newline at end of file diff --git a/docs/mw/FavIcon.html b/docs/mw/FavIcon.html index 3e1b7bf..681fc65 100644 --- a/docs/mw/FavIcon.html +++ b/docs/mw/FavIcon.html @@ -1,2 +1,2 @@ -mw.FavIcon - Express Externs and Middleware for Haxe

    package mw

    class mw.FavIcon

    defined in mw.Favicon

    Available on all platforms

    Static methods

    static create (path:String, ?options:{maxAge:EitherType<Float, String>}):Middleware

    \ No newline at end of file +mw.FavIcon - Express Externs and Middleware for Haxe

    package mw

    class mw.FavIcon

    Static methods

    static create (path :String, ?options :{maxAge:EitherType<Float, String>}) :Middleware

    \ No newline at end of file diff --git a/docs/mw/Jwt.html b/docs/mw/Jwt.html index 2183b7f..6d957fb 100644 --- a/docs/mw/Jwt.html +++ b/docs/mw/Jwt.html @@ -1,2 +1,2 @@ -mw.Jwt - Express Externs and Middleware for Haxe

    package mw

    class mw.Jwt

    Available on all platforms

    Static methods

    static create (?options:Options):UnlessMiddleware

    \ No newline at end of file +mw.Jwt - Express Externs and Middleware for Haxe

    package mw

    class mw.Jwt

    Static methods

    static create (?options :Null<Options>) :UnlessMiddleware

    \ No newline at end of file diff --git a/docs/mw/Morgan.html b/docs/mw/Morgan.html index 2098c84..ab4636c 100644 --- a/docs/mw/Morgan.html +++ b/docs/mw/Morgan.html @@ -1,2 +1,2 @@ -mw.Morgan - Express Externs and Middleware for Haxe

    package mw

    class mw.Morgan

    Available on all platforms

    Static methods

    static create (format:String, ?options:Options):Middleware

    static token (type:String, callback:Request -> Response -> String):Void

    \ No newline at end of file +mw.Morgan - Express Externs and Middleware for Haxe

    package mw

    class mw.Morgan

    Static methods

    static create (format :String, ?options :Null<Options>) :Middleware

    static token (type :String, callback :Request -> Response -> String) :Void

    \ No newline at end of file diff --git a/docs/mw/OnFinished.html b/docs/mw/OnFinished.html new file mode 100644 index 0000000..109d52e --- /dev/null +++ b/docs/mw/OnFinished.html @@ -0,0 +1,2 @@ + +mw.OnFinished - Express Externs and Middleware for Haxe

    package mw

    class mw.OnFinished

    Static methods

    static isFinished (res :Response) :Bool

    static isFinished (req :Request) :Bool

    static listen (res :Response, callback :Null<Error> -> Response -> Void) :Void

    static listen (req :Request, callback :Null<Error> -> Request -> Void) :Void

    \ No newline at end of file diff --git a/docs/mw/Passport.html b/docs/mw/Passport.html index f0bcb88..fe54d5f 100644 --- a/docs/mw/Passport.html +++ b/docs/mw/Passport.html @@ -1,2 +1,2 @@ -mw.Passport - Express Externs and Middleware for Haxe

    package mw

    class mw.Passport

    Available on all platforms

    Constructor

    new ()

    Methods

    authenticate (strategy:String, ?options:Dynamic, callback:Dynamic):Middleware

    authorize (strategy:String, ?options:Dynamic, callback:Dynamic):Middleware

    deserializeUser (callback:Dynamic):Void

    initialize (?options:Dynamic):Middleware

    serializeUser (callback:Dynamic):Void

    session (?options:Dynamic):Middleware

    transformAuthInfo (callback:Dynamic):Void

    unuse (name:String):Passport

    use (?name:String, strategy:Strategy<Dynamic>):Passport

    \ No newline at end of file +mw.Passport - Express Externs and Middleware for Haxe

    package mw

    class mw.Passport

    Static methods

    static authenticate (strategy :String, ?options :Dynamic, callback :Dynamic) :Middleware

    static authorize (strategy :String, ?options :Dynamic, callback :Dynamic) :Middleware

    static deserializeUser (callback :Dynamic) :Void

    static initialize (?options :Dynamic) :Middleware

    static serializeUser (callback :Dynamic) :Void

    static session (?options :Dynamic) :Middleware

    static transformAuthInfo (callback :Dynamic) :Void

    static unuse (name :String) :Passport

    static use (?name :String, strategy :Strategy<Dynamic>) :Passport

    \ No newline at end of file diff --git a/docs/mw/SSLOnly.html b/docs/mw/SSLOnly.html new file mode 100644 index 0000000..2639529 --- /dev/null +++ b/docs/mw/SSLOnly.html @@ -0,0 +1,2 @@ + +mw.SSLOnly - Express Externs and Middleware for Haxe

    package mw

    class mw.SSLOnly

    Static methods

    static create () :Request -> Response -> Next -> Void

    \ No newline at end of file diff --git a/docs/mw/Slash.html b/docs/mw/Slash.html index 2ac97a2..94a0152 100644 --- a/docs/mw/Slash.html +++ b/docs/mw/Slash.html @@ -1,2 +1,2 @@ -mw.Slash - Express Externs and Middleware for Haxe

    package mw

    class mw.Slash

    Available on all platforms

    Static methods

    static create (?statusCode:Int):Middleware

    \ No newline at end of file +mw.Slash - Express Externs and Middleware for Haxe

    package mw

    class mw.Slash

    Static methods

    static create (?statusCode :Int) :Middleware

    \ No newline at end of file diff --git a/docs/mw/Uncapitalize.html b/docs/mw/Uncapitalize.html index ac8fc98..888e02d 100644 --- a/docs/mw/Uncapitalize.html +++ b/docs/mw/Uncapitalize.html @@ -1,2 +1,2 @@ -mw.Uncapitalize - Express Externs and Middleware for Haxe

    package mw

    class mw.Uncapitalize

    Available on all platforms

    Static methods

    static create ():Middleware

    \ No newline at end of file +mw.Uncapitalize - Express Externs and Middleware for Haxe

    package mw

    class mw.Uncapitalize

    Static methods

    static create () :Middleware

    \ No newline at end of file diff --git a/docs/mw/Unless.html b/docs/mw/Unless.html index 9e2b8b6..14cd79e 100644 --- a/docs/mw/Unless.html +++ b/docs/mw/Unless.html @@ -1,2 +1,2 @@ -mw.Unless - Express Externs and Middleware for Haxe

    package mw

    class mw.Unless

    Available on all platforms

    Static methods

    static create (?options:UnlessOptions):UnlessMiddleware

    \ No newline at end of file +mw.Unless - Express Externs and Middleware for Haxe

    package mw

    class mw.Unless

    Static methods

    static create (?options :Null<UnlessOptions>) :UnlessMiddleware

    \ No newline at end of file diff --git a/docs/mw/UnlessMiddleware.html b/docs/mw/UnlessMiddleware.html index bf4f36a..7fd4bd5 100644 --- a/docs/mw/UnlessMiddleware.html +++ b/docs/mw/UnlessMiddleware.html @@ -1,2 +1,2 @@ -mw.UnlessMiddleware - Express Externs and Middleware for Haxe

    package mw

    typedef mw.UnlessMiddleware

    alias for EitherType<Middleware, Unless>

    defined in mw.Unless

    Available on all platforms

    \ No newline at end of file +mw.UnlessMiddleware - Express Externs and Middleware for Haxe

    package mw

    typedef mw.UnlessMiddleware

    alias for EitherType<Middleware, Unless>

    defined in mw.Unless

    \ No newline at end of file diff --git a/docs/mw/UnlessOptions.html b/docs/mw/UnlessOptions.html index fc22727..5da0f31 100644 --- a/docs/mw/UnlessOptions.html +++ b/docs/mw/UnlessOptions.html @@ -1,2 +1,2 @@ -mw.UnlessOptions - Express Externs and Middleware for Haxe

    package mw

    typedef mw.UnlessOptions

    defined in mw.Unless

    Available on all platforms

    Properties

    useOriginalUrl:Null<Bool>

    path:Null<EitherType<String, EitherType<RegExp, Array<String>>>>

    method:Null<EitherType<String, Array<String>>>

    ext:Null<EitherType<String, Array<String>>>

    custom:Null<Request -> Bool>

    \ No newline at end of file +mw.UnlessOptions - Express Externs and Middleware for Haxe

    package mw

    typedef mw.UnlessOptions

    defined in mw.Unless

    Properties

    custom :Null<Request -> Bool>

    ext :Null<EitherType<String, Array<String>>>

    method :Null<EitherType<String, Array<String>>>

    path :Null<EitherType<String, EitherType<RegExp, Array<String>>>>

    useOriginalUrl :Null<Bool>

    \ No newline at end of file diff --git a/docs/mw/bodyparser/JsonOptions.html b/docs/mw/bodyparser/JsonOptions.html index d028919..c7d6e28 100644 --- a/docs/mw/bodyparser/JsonOptions.html +++ b/docs/mw/bodyparser/JsonOptions.html @@ -1,2 +1,2 @@ -mw.bodyparser.JsonOptions - Express Externs and Middleware for Haxe

    package mw.bodyparser

    typedef mw.bodyparser.JsonOptions

    Available on all platforms

    Properties

    verify:Null<Request -> Response -> Buffer -> String -> Void>

    type:Null<EitherType<String, Request -> Bool>>

    strict:Null<Bool>

    reviver:Null<String -> Dynamic -> Dynamic>

    limit:Null<EitherType<String, Int>>

    inflate:Null<Bool>

    \ No newline at end of file +mw.bodyparser.JsonOptions - Express Externs and Middleware for Haxe

    package mw.bodyparser

    typedef mw.bodyparser.JsonOptions

    Properties

    inflate :Null<Bool>

    limit :Null<EitherType<String, Int>>

    reviver :Null<String -> Dynamic -> Dynamic>

    strict :Null<Bool>

    type :Null<EitherType<String, Request -> Bool>>

    verify :Null<Request -> Response -> Buffer -> String -> Void>

    \ No newline at end of file diff --git a/docs/mw/bodyparser/RawOptions.html b/docs/mw/bodyparser/RawOptions.html index 31b1ece..01b5f1d 100644 --- a/docs/mw/bodyparser/RawOptions.html +++ b/docs/mw/bodyparser/RawOptions.html @@ -1,2 +1,2 @@ -mw.bodyparser.RawOptions - Express Externs and Middleware for Haxe

    package mw.bodyparser

    typedef mw.bodyparser.RawOptions

    Available on all platforms

    Properties

    verify:Null<Request -> Response -> Buffer -> String -> Void>

    type:Null<EitherType<String, Request -> Bool>>

    limit:Null<EitherType<String, Int>>

    inflate:Null<Bool>

    \ No newline at end of file +mw.bodyparser.RawOptions - Express Externs and Middleware for Haxe

    package mw.bodyparser

    typedef mw.bodyparser.RawOptions

    Properties

    inflate :Null<Bool>

    limit :Null<EitherType<String, Int>>

    type :Null<EitherType<String, Request -> Bool>>

    verify :Null<Request -> Response -> Buffer -> String -> Void>

    \ No newline at end of file diff --git a/docs/mw/bodyparser/TextOptions.html b/docs/mw/bodyparser/TextOptions.html index 3f2056f..3620524 100644 --- a/docs/mw/bodyparser/TextOptions.html +++ b/docs/mw/bodyparser/TextOptions.html @@ -1,2 +1,2 @@ -mw.bodyparser.TextOptions - Express Externs and Middleware for Haxe

    package mw.bodyparser

    typedef mw.bodyparser.TextOptions

    Available on all platforms

    Properties

    verify:Null<Request -> Response -> Buffer -> String -> Void>

    type:Null<EitherType<String, Request -> Bool>>

    limit:Null<EitherType<String, Int>>

    inflate:Null<Bool>

    defaultCharset:Null<String>

    \ No newline at end of file +mw.bodyparser.TextOptions - Express Externs and Middleware for Haxe

    package mw.bodyparser

    typedef mw.bodyparser.TextOptions

    Properties

    defaultCharset :Null<String>

    inflate :Null<Bool>

    limit :Null<EitherType<String, Int>>

    type :Null<EitherType<String, Request -> Bool>>

    verify :Null<Request -> Response -> Buffer -> String -> Void>

    \ No newline at end of file diff --git a/docs/mw/bodyparser/UrlEncodedOptions.html b/docs/mw/bodyparser/UrlEncodedOptions.html new file mode 100644 index 0000000..91c5f3a --- /dev/null +++ b/docs/mw/bodyparser/UrlEncodedOptions.html @@ -0,0 +1,2 @@ + +mw.bodyparser.UrlEncodedOptions - Express Externs and Middleware for Haxe

    package mw.bodyparser

    typedef mw.bodyparser.UrlEncodedOptions

    Properties

    extended :Bool

    inflate :Null<Bool>

    limit :Null<EitherType<String, Int>>

    parameterLimit :Null<Int>

    type :Null<EitherType<String, Request -> Bool>>

    verify :Null<Request -> Response -> Buffer -> String -> Void>

    \ No newline at end of file diff --git a/docs/mw/bodyparser/index.html b/docs/mw/bodyparser/index.html index 0507cea..93b6ca6 100644 --- a/docs/mw/bodyparser/index.html +++ b/docs/mw/bodyparser/index.html @@ -1,2 +1,2 @@ -mw.bodyparser - Express Externs and Middleware for Haxe

    package mw.bodyparser

    JsonOptions

    RawOptions

    TextOptions

    \ No newline at end of file +mw.bodyparser - Express Externs and Middleware for Haxe

    package mw.bodyparser

    JsonOptions

    RawOptions

    TextOptions

    UrlEncodedOptions

    \ No newline at end of file diff --git a/docs/mw/busboy/Options.html b/docs/mw/busboy/Options.html index 60d8841..dc13b1b 100644 --- a/docs/mw/busboy/Options.html +++ b/docs/mw/busboy/Options.html @@ -1,2 +1,2 @@ -mw.busboy.Options - Express Externs and Middleware for Haxe

    package mw.busboy

    typedef mw.busboy.Options

    Available on all platforms

    Properties

    limits:Null<{parts:Null<Int>, headerPairs:Null<Int>, files:Null<Int>, fileSize:Null<Int>, fields:Null<Int>, fieldSize:Null<Int>, fieldNameSize:Null<Int>}>

    immediate:Null<Bool>

    highWaterMark:Null<Int>

    fileHwm:Null<Int>

    defCharset:Null<String>

    \ No newline at end of file +mw.busboy.Options - Express Externs and Middleware for Haxe

    package mw.busboy

    typedef mw.busboy.Options

    Properties

    defCharset :Null<String>

    fileHwm :Null<Int>

    highWaterMark :Null<Int>

    immediate :Null<Bool>

    limits :Null<{parts:Null<Int>, headerPairs:Null<Int>, files:Null<Int>, fileSize:Null<Int>, fields:Null<Int>, fieldSize:Null<Int>, fieldNameSize:Null<Int>}>

    \ No newline at end of file diff --git a/docs/mw/compression/CompressionOptions.html b/docs/mw/compression/CompressionOptions.html index b57978f..c28023b 100644 --- a/docs/mw/compression/CompressionOptions.html +++ b/docs/mw/compression/CompressionOptions.html @@ -1,2 +1,2 @@ -mw.compression.CompressionOptions - Express Externs and Middleware for Haxe

    package mw.compression

    typedef mw.compression.CompressionOptions

    Available on all platforms

    Properties

    windowBits:Null<Int>

    threshold:Null<EitherType<Int, EitherType<String, Bool>>>

    strategy:Null<String>

    memLevel:Null<Int>

    level:Null<Int>

    filter:Null<Request -> Response -> Bool>

    chunkSize:Null<Int>

    \ No newline at end of file +mw.compression.CompressionOptions - Express Externs and Middleware for Haxe

    package mw.compression

    typedef mw.compression.CompressionOptions

    Properties

    chunkSize :Null<Int>

    filter :Null<Request -> Response -> Bool>

    level :Null<Int>

    memLevel :Null<Int>

    strategy :Null<String>

    threshold :Null<EitherType<Int, EitherType<String, Bool>>>

    windowBits :Null<Int>

    \ No newline at end of file diff --git a/docs/mw/cookiesession/CookieOptions.html b/docs/mw/cookiesession/CookieOptions.html index 2863f8b..4127c81 100644 --- a/docs/mw/cookiesession/CookieOptions.html +++ b/docs/mw/cookiesession/CookieOptions.html @@ -1,2 +1,2 @@ -mw.cookiesession.CookieOptions - Express Externs and Middleware for Haxe

    package mw.cookiesession

    typedef mw.cookiesession.CookieOptions

    Available on all platforms

    Properties

    signed:Null<Bool>

    secureProxy:Null<Bool>

    secure:Null<Bool>

    path:Null<String>

    overwrite:Null<Bool>

    maxAge:Null<Float>

    httpOnly:Null<Bool>

    expires:Null<Date>

    domain:Null<String>

    \ No newline at end of file +mw.cookiesession.CookieOptions - Express Externs and Middleware for Haxe

    package mw.cookiesession

    typedef mw.cookiesession.CookieOptions

    Properties

    domain :Null<String>

    expires :Null<Date>

    httpOnly :Null<Bool>

    maxAge :Null<Float>

    overwrite :Null<Bool>

    path :Null<String>

    secure :Null<Bool>

    secureProxy :Null<Bool>

    signed :Null<Bool>

    \ No newline at end of file diff --git a/docs/mw/cookiesession/SessionOptions.html b/docs/mw/cookiesession/SessionOptions.html index 9e39144..4916b8f 100644 --- a/docs/mw/cookiesession/SessionOptions.html +++ b/docs/mw/cookiesession/SessionOptions.html @@ -1,2 +1,2 @@ -mw.cookiesession.SessionOptions - Express Externs and Middleware for Haxe

    package mw.cookiesession

    typedef mw.cookiesession.SessionOptions

    Available on all platforms

    Properties

    secret:Null<String>

    name:Null<String>

    keys:Null<Array<String>>

    \ No newline at end of file +mw.cookiesession.SessionOptions - Express Externs and Middleware for Haxe

    package mw.cookiesession

    typedef mw.cookiesession.SessionOptions

    Properties

    keys :Null<Array<String>>

    name :Null<String>

    secret :Null<String>

    \ No newline at end of file diff --git a/docs/mw/cors/Options.html b/docs/mw/cors/Options.html index 464469b..6c79529 100644 --- a/docs/mw/cors/Options.html +++ b/docs/mw/cors/Options.html @@ -1,2 +1,2 @@ -mw.cors.Options - Express Externs and Middleware for Haxe

    package mw.cors

    typedef mw.cors.Options

    Available on all platforms

    Properties

    origin:Null<EitherType<Bool, EitherType<String, OriginFunction>>>

    methods:Null<EitherType<String, Array<String>>>

    maxAge:Null<Int>

    exposedHeaders:Null<EitherType<String, Array<String>>>

    credentials:Null<Bool>

    allowedHeaders:Null<EitherType<String, Array<String>>>

    \ No newline at end of file +mw.cors.Options - Express Externs and Middleware for Haxe

    package mw.cors

    typedef mw.cors.Options

    Properties

    allowedHeaders :Null<EitherType<String, Array<String>>>

    credentials :Null<Bool>

    exposedHeaders :Null<EitherType<String, Array<String>>>

    maxAge :Null<Int>

    methods :Null<EitherType<String, Array<String>>>

    origin :Null<EitherType<Bool, EitherType<String, OriginFunction>>>

    \ No newline at end of file diff --git a/docs/mw/cors/OriginFunction.html b/docs/mw/cors/OriginFunction.html index 03bf62d..ccaae91 100644 --- a/docs/mw/cors/OriginFunction.html +++ b/docs/mw/cors/OriginFunction.html @@ -1,2 +1,2 @@ -mw.cors.OriginFunction - Express Externs and Middleware for Haxe

    package mw.cors

    typedef mw.cors.OriginFunction

    alias for String -> Error -> Bool -> Void -> Void

    defined in mw.cors.Options

    Available on all platforms

    \ No newline at end of file +mw.cors.OriginFunction - Express Externs and Middleware for Haxe

    package mw.cors

    typedef mw.cors.OriginFunction

    alias for String -> Error -> Bool -> Void -> Void

    defined in mw.cors.Options

    \ No newline at end of file diff --git a/docs/mw/expressbrute/MiddlewareOptions.html b/docs/mw/expressbrute/MiddlewareOptions.html new file mode 100644 index 0000000..d01d267 --- /dev/null +++ b/docs/mw/expressbrute/MiddlewareOptions.html @@ -0,0 +1,2 @@ + +mw.expressbrute.MiddlewareOptions - Express Externs and Middleware for Haxe

    package mw.expressbrute

    typedef mw.expressbrute.MiddlewareOptions

    Properties

    failCallback :Null<Request -> Response -> Next -> Date -> Void>

    key :EitherType<String, Request -> Response -> Next -> Void>

    \ No newline at end of file diff --git a/docs/mw/expressbrute/Options.html b/docs/mw/expressbrute/Options.html new file mode 100644 index 0000000..0dff1d3 --- /dev/null +++ b/docs/mw/expressbrute/Options.html @@ -0,0 +1,2 @@ + +mw.expressbrute.Options - Express Externs and Middleware for Haxe

    package mw.expressbrute

    typedef mw.expressbrute.Options

    Properties

    attachResetToRequest :Null<Bool>

    failCallback :Null<Request -> Response -> Next -> Date -> Void>

    freeRetries :Null<Int>

    handleStoreError :Null<EitherType<{parent:Error, message:String} -> String -> String -> Void, {parent:Error, message:String} -> Request -> Response -> Next -> Void>>

    lifetime :Null<Float>

    maxWait :Null<Float>

    minWait :Null<Float>

    proxyDepth :Null<Int>

    refreshTimeoutOnRequest :Null<Bool>

    \ No newline at end of file diff --git a/docs/mw/expressbrute/Store.html b/docs/mw/expressbrute/Store.html new file mode 100644 index 0000000..4294161 --- /dev/null +++ b/docs/mw/expressbrute/Store.html @@ -0,0 +1,2 @@ + +mw.expressbrute.Store - Express Externs and Middleware for Haxe

    package mw.expressbrute

    interface mw.expressbrute.Store

    \ No newline at end of file diff --git a/docs/mw/expressbrute/index.html b/docs/mw/expressbrute/index.html new file mode 100644 index 0000000..5e9ebca --- /dev/null +++ b/docs/mw/expressbrute/index.html @@ -0,0 +1,2 @@ + +mw.expressbrute - Express Externs and Middleware for Haxe

    package mw.expressbrute

    MiddlewareOptions

    Options

    Store

    \ No newline at end of file diff --git a/docs/mw/index.html b/docs/mw/index.html index 9eae575..208d9c4 100644 --- a/docs/mw/index.html +++ b/docs/mw/index.html @@ -1,2 +1,2 @@ -mw - Express Externs and Middleware for Haxe

    package mw

    bodyparser
    busboy
    compression
    cookiesession
    cors
    jwt
    morgan
    passport
    BodyParser

    Busboy

    Compression

    CookieParser

    CookieSession

    Cors

    FavIcon

    Jwt

    Morgan

    Passport

    Slash

    Uncapitalize

    Unless

    UnlessMiddleware

    UnlessOptions

    \ No newline at end of file +mw - Express Externs and Middleware for Haxe

    package mw

    bodyparser
    busboy
    compression
    cookiesession
    cors
    expressbrute
    jwt
    morgan
    passport
    BasicAuth

    BearerTokenAuth

    BodyParser

    Busboy

    Compression

    CookieParser

    CookieSession

    Cors

    ExpressBrute

    ExpressForceSSL

    FavIcon

    Jwt

    Morgan

    OnFinished

    Passport

    SSLOnly

    Slash

    Uncapitalize

    Unless

    UnlessMiddleware

    UnlessOptions

    \ No newline at end of file diff --git a/docs/mw/jwt/Options.html b/docs/mw/jwt/Options.html index 589b882..8f3d4e2 100644 --- a/docs/mw/jwt/Options.html +++ b/docs/mw/jwt/Options.html @@ -1,2 +1,2 @@ -mw.jwt.Options - Express Externs and Middleware for Haxe

    package mw.jwt

    typedef mw.jwt.Options

    Available on all platforms

    Properties

    userProperty:Null<String>

    secret:Null<String>

    getToken:Null<Request -> String>

    credentialsRequired:Null<Bool>

    \ No newline at end of file +mw.jwt.Options - Express Externs and Middleware for Haxe

    package mw.jwt

    typedef mw.jwt.Options

    Properties

    algorithms :Null<Array<String>>

    credentialsRequired :Null<Bool>

    getToken :Null<Request -> String>

    secret :Null<String>

    userProperty :Null<String>

    \ No newline at end of file diff --git a/docs/mw/morgan/Options.html b/docs/mw/morgan/Options.html index 9826700..cbdffe1 100644 --- a/docs/mw/morgan/Options.html +++ b/docs/mw/morgan/Options.html @@ -1,2 +1,2 @@ -mw.morgan.Options - Express Externs and Middleware for Haxe

    package mw.morgan

    typedef mw.morgan.Options

    Available on all platforms

    Properties

    stream:Null<WriteStream>

    skip:Null<Request -> Response -> Bool>

    immediate:Null<Bool>

    \ No newline at end of file +mw.morgan.Options - Express Externs and Middleware for Haxe

    package mw.morgan

    typedef mw.morgan.Options

    Properties

    immediate :Null<Bool>

    skip :Null<Request -> Response -> Bool>

    stream :Null<WriteStream>

    \ No newline at end of file diff --git a/docs/mw/passport/Strategy.html b/docs/mw/passport/Strategy.html index 230c225..c92e363 100644 --- a/docs/mw/passport/Strategy.html +++ b/docs/mw/passport/Strategy.html @@ -1,2 +1,2 @@ -mw.passport.Strategy - Express Externs and Middleware for Haxe

    package mw.passport

    class mw.passport.Strategy<T>

    Available on all platforms

    Properties

    name:String

    Methods

    authenticate (request:Request, options:T):Void

    \ No newline at end of file +mw.passport.Strategy - Express Externs and Middleware for Haxe

    package mw.passport

    class mw.passport.Strategy<T>

    Properties

    name :String

    Methods

    authenticate (request :Request, options :T) :Void

    \ No newline at end of file diff --git a/docs/nav.js b/docs/nav.js index a01ce49..89fe79b 100644 --- a/docs/nav.js +++ b/docs/nav.js @@ -1 +1 @@ -var navContent=''; \ No newline at end of file +var navContent=''; \ No newline at end of file diff --git a/docs/offline.zip b/docs/offline.zip new file mode 100644 index 0000000..fe58213 Binary files /dev/null and b/docs/offline.zip differ diff --git a/docs/styles.css b/docs/styles.css index 41d142a..d463a25 100644 --- a/docs/styles.css +++ b/docs/styles.css @@ -32,10 +32,6 @@ #nav.searching .pack { display:inline; } #nav.searching .nav-list .nav-list { padding-left: 0; padding-right: 0; } -.nav-header { - text-transform: none; -} - /* h1 code { padding:4px; font-size:15px; } */ /* h3 code { padding:4px; font-size:13px; } */ code { diff --git a/generate.sh b/generate.sh index aeac215..04e81c8 100755 --- a/generate.sh +++ b/generate.sh @@ -1,4 +1,5 @@ #!/bin/sh +haxe build.hxml haxelib run dox -o docs -i xml/js.xml --title "Express Externs and Middleware for Haxe" -in mw -in express -theme flambe git archive -o docs/offline.zip HEAD docs rm -f docs/offline.zip diff --git a/src/mw/BearerTokenAuth.hx b/src/mw/BearerTokenAuth.hx index af8466f..9f9dd9a 100644 --- a/src/mw/BearerTokenAuth.hx +++ b/src/mw/BearerTokenAuth.hx @@ -17,7 +17,7 @@ class BearerTokenAuth { return; } - var authorizationHeader = req.headers[AUTHORIZATION]; + var authorizationHeader:String = req.headers[AUTHORIZATION]; if (authorizationHeader == null || authorizationHeader.trim() == "") { send401(res, '"$AUTHORIZATION header has no value'); return; diff --git a/xml/js.xml b/xml/js.xml deleted file mode 100644 index a2f7afc..0000000 --- a/xml/js.xml +++ /dev/null @@ -1,9993 +0,0 @@ - - - - - The length of `this` Array. - - - - - - - Returns a new Array by appending the elements of `a` to the elements of - `this` Array. - - This operation does not modify `this` Array. - - If `a` is the empty Array `[]`, a copy of `this` Array is returned. - - The length of the returned Array is equal to the sum of `this.length` - and `a.length`. - - If `a` is `null`, the result is unspecified. - - - - - - - Returns a string representation of `this` Array, with `sep` separating - each element. - - The result of this operation is equal to `Std.string(this[0]) + sep + - Std.string(this[1]) + sep + ... + sep + Std.string(this[this.length-1])` - - If `this` is the empty Array `[]`, the result is the empty String `""`. - If `this` has exactly one element, the result is equal to a call to - `Std.string(this[0])`. - - If `sep` is null, the result is unspecified. - - - - Removes the last element of `this` Array and returns it. - - This operation modifies `this` Array in place. - - If `this` has at least one element, `this.length` will decrease by 1. - - If `this` is the empty Array `[]`, null is returned and the length - remains 0. - - - - - - - Adds the element `x` at the end of `this` Array and returns the new - length of `this` Array. - - This operation modifies `this` Array in place. - - `this.length` increases by 1. - - - - - - - - Removes the first element of `this` Array and returns it. - - This operation modifies `this` Array in place. - - If `this` has at least one element, `this`.length and the index of each - remaining element is decreased by 1. - - If `this` is the empty Array `[]`, `null` is returned and the length - remains 0. - - - - - - - - Creates a shallow copy of the range of `this` Array, starting at and - including `pos`, up to but not including `end`. - - This operation does not modify `this` Array. - - The elements are not copied and retain their identity. - - If `end` is omitted or exceeds `this.length`, it defaults to the end of - `this` Array. - - If `pos` or `end` are negative, their offsets are calculated from the - end of `this` Array by `this.length + pos` and `this.length + end` - respectively. If this yields a negative value, 0 is used instead. - - If `pos` exceeds `this.length` or if `end` exceeds or equals `pos`, - the result is `[]`. - - - - - - - - - - - y and a - negative Int if x < y. - - This operation modifies `this` Array in place. - - The sort operation is not guaranteed to be stable, which means that the - order of equal elements may not be retained. For a stable Array sorting - algorithm, `haxe.ds.ArraySort.sort()` can be used instead. - - If `f` is null, the result is unspecified.]]> - - - - - - - - - - - - Returns a string representation of `this` Array. - - The result will include the individual elements' String representations - separated by comma. The enclosing [ ] may be missing on some platforms, - use `Std.string()` to get a String representation that is consistent - across platforms. - - - - - - - Adds the element `x` at the start of `this` Array. - - This operation modifies `this` Array in place. - - `this.length` and the index of each Array element increases by 1. - - - - - - - - - Inserts the element `x` at the position `pos`. - - This operation modifies `this` Array in place. - - The offset is calculated like so: - - - If `pos` exceeds `this.length`, the offset is `this.length`. - - If `pos` is negative, the offset is calculated from the end of `this` - Array, i.e. `this.length + pos`. If this yields a negative value, the - offset is 0. - - Otherwise, the offset is `pos`. - - If the resulting offset does not exceed `this.length`, all elements from - and including that offset to the end of `this` Array are moved one index - ahead. - - - - - - - Removes the first occurence of `x` in `this` Array. - - This operation modifies `this` Array in place. - - If `x` is found by checking standard equality, it is removed from `this` - Array and all following elements are reindexed acoordingly. The function - then returns true. - - If `x` is not found, `this` Array is not changed and the function - returns false. - - - - - - - - Returns position of the first occurense of `x` in `this` Array, searching front to back. - - If `x` is found by checking standard equality, the function returns its index. - - If `x` is not found, the function returns -1. - - If `fromIndex` is specified, it will be used as the starting index to search from, - otherwise search starts with zero index. If it is negative, it will be taken as the - offset from the end of `this` Array to compute the starting index. If given or computed - starting index is less than 0, the whole array will be searched, if it is greater than - or equal to the length of `this` Array, the function returns -1. - - - - - - - - Returns position of the last occurense of `x` in `this` Array, searching back to front. - - If `x` is found by checking standard equality, the function returns its index. - - If `x` is not found, the function returns -1. - - If `fromIndex` is specified, it will be used as the starting index to search from, - otherwise search starts with the last element index. If it is negative, it will be - taken as the offset from the end of `this` Array to compute the starting index. If - given or computed starting index is greater than or equal to the length of `this` Array, - the whole array will be searched, if it is less than 0, the function returns -1. - - - - - Returns a shallow copy of `this` Array. - - The elements are not copied and retain their identity, so - `a[i] == a.copy()[i]` is true for any valid `i`. However, - `a == a.copy()` is always false. - - - - - - - - - - Creates a new Array by applying function `f` to all elements of `this`. - - The order of elements is preserved. - - If `f` is null, the result is unspecified. - - - - - - - - - - Returns an Array containing those elements of `this` for which `f` - returned true. - - The individual elements are not duplicated and retain their identity. - - If `f` is null, the result is unspecified. - - - - - - - - Returns an iterator of the Array values. - - - - Creates a new Array. - - An Array is a storage for values. You can access it using indexes or - with its API. - - @see http://haxe.org/manual/std-Array.html - @see http://haxe.org/manual/lf-array-comprehension.html - - - - - An abstract type that represents a Class. - - See `Type` for the Haxe Reflection API. - - @see http://haxe.org/manual/types-class-instance.html - - - - - - - - - - Returns a Date representing the current local time. - - - - - - - - Returns a Date from timestamp `t`. - - - - - - - - Returns a Date from a formated string `s`, with the following accepted - formats: - - - `"YYYY-MM-DD hh:mm:ss"` - - `"YYYY-MM-DD"` - - `"hh:mm:ss"` - - The first two formats are expressed in local time, the third in UTC - Epoch. - - - - Returns the timestamp of the date. It might only have a per-second - precision depending on the platforms. - - - - Returns the hours of `this` Date (0-23 range). - - - - Returns the minutes of `this` Date (0-59 range). - - - - Returns the seconds of the `this` Date (0-59 range). - - - - Returns the full year of `this` Date (4-digits). - - - - Returns the month of `this` Date (0-11 range). - - - - Returns the day of `this` Date (1-31 range). - - - - Returns the day of the week of `this` Date (0-6 range). - - - - - Returns a string representation of `this` Date, by using the - standard format [YYYY-MM-DD HH:MM:SS]. See `DateTools.format` for - other formating rules. - - - - - - - - - - - - Creates a new date object from the given arguments. - - The behaviour of a Date instance is only consistent across platforms if - the the arguments describe a valid date. - - - month: 0 to 11 - - day: 1 to 31 - - hour: 0 to 23 - - min: 0 to 59 - - sec: 0 to 59 - - The Date class provides a basic structure for date and time related - information. Date instances can be created by - - - `new Date()` for a specific date, - - `Date.now()` to obtain information about the current time, - - `Date.fromTime()` with a given timestamp or - - `Date.fromString()` by parsing from a String. - - There are some extra functions available in the `DateTools` class. - - In the context of Haxe dates, a timestamp is defined as the number of - milliseconds elapsed since 1st January 1970. - - - - - - - - - - Tells if `this` regular expression matches String `s`. - - This method modifies the internal state. - - If `s` is `null`, the result is unspecified. - - - - - - - Returns the matched sub-group `n` of `this` EReg. - - This method should only be called after `this.match` or - `this.matchSub`, and then operates on the String of that operation. - - The index `n` corresponds to the n-th set of parentheses in the pattern - of `this` EReg. If no such sub-group exists, an exception is thrown. - - If `n` equals 0, the whole matched substring is returned. - - - - Returns the part to the left of the last matched substring. - - If the most recent call to `this.match` or `this.matchSub` did not - match anything, the result is unspecified. - - If the global g modifier was in place for the matching, only the - substring to the left of the leftmost match is returned. - - The result does not include the matched part. - - - - Returns the part to the right of the last matched substring. - - If the most recent call to `this.match` or `this.matchSub` did not - match anything, the result is unspecified. - - If the global g modifier was in place for the matching, only the - substring to the right of the leftmost match is returned. - - The result does not include the matched part. - - - - - - - Returns the position and length of the last matched substring, within - the String which was last used as argument to `this.match` or - `this.matchSub`. - - If the most recent call to `this.match` or `this.matchSub` did not - match anything, the result is unspecified. - - If the global g modifier was in place for the matching, the position and - length of the leftmost substring is returned. - - - - - - - - - { len : -1 } - Tells if `this` regular expression matches a substring of String `s`. - - This function expects `pos` and `len` to describe a valid substring of - `s`, or else the result is unspecified. To get more robust behavior, - `this.match(s.substr(pos,len))` can be used instead. - - This method modifies the internal state. - - If `s` is null, the result is unspecified. - - - - - - - - Splits String `s` at all substrings `this` EReg matches. - - If a match is found at the start of `s`, the result contains a leading - empty String "" entry. - - If a match is found at the end of `s`, the result contains a trailing - empty String "" entry. - - If two matching substrings appear next to each other, the result - contains the empty String `""` between them. - - By default, this method splits `s` into two parts at the first matched - substring. If the global g modifier is in place, `s` is split at each - matched substring. - - If `s` is null, the result is unspecified. - - - - - - - - - Replaces the first substring of `s` which `this` EReg matches with `by`. - - If `this` EReg does not match any substring, the result is `s`. - - By default, this method replaces only the first matched substring. If - the global g modifier is in place, all matched substrings are replaced. - - If `by` contains `$1` to `$9`, the digit corresponds to number of a - matched sub-group and its value is used instead. If no such sub-group - exists, the replacement is unspecified. The string `$$` becomes `$`. - - If `s` or `by` are null, the result is unspecified. - - - - - - - - - - - Calls the function `f` for the substring of `s` which `this` EReg matches - and replaces that substring with the result of `f` call. - - The `f` function takes `this` EReg object as its first argument and should - return a replacement string for the substring matched. - - If `this` EReg does not match any substring, the result is `s`. - - By default, this method replaces only the first matched substring. If - the global g modifier is in place, all matched substrings are replaced. - - If `s` or `f` are null, the result is unspecified. - - - - - - - - Creates a new regular expression with pattern `r` and modifiers `opt`. - - This is equivalent to the shorthand syntax `~/r/opt` - - If `r` or `opt` are null, the result is unspecified. - - ]]> - - - - - - - - - - - - - - - - - - - - - - - Native JavaScript regular expressions. - - For cross-platform regular expressions, use Haxe `EReg` class or - [regexp literals](http://haxe.org/manual/std-regex.html). - "RegExp" - - - - - - "RegExp" - - - - An abstract type that represents an Enum type. - - The corresponding enum instance type is `EnumValue`. - - See `Type` for the Haxe Reflection API. - - @see http://haxe.org/manual/types-enum-instance.html - - - - - - - - An abstract type that represents any enum value. - See `Type` for the Haxe Reflection API. - - @see http://haxe.org/manual/types-enum-instance.html - - - - - - - - Returns true if the iterator has other items, false otherwise. - - - - Moves to the next item of the iterator. - - If this is called while hasNext() is false, the result is unspecified. - - - - - - - - - - IntIterator is used for implementing interval iterations. - - It is usually not used explicitly, but through its special syntax: - `min...max` - - While it is possible to assign an instance of IntIterator to a variable or - field, it is worth noting that IntIterator does not reset after being used - in a for-loop. Subsequent uses of the same instance will then have no - effect. - - @see http://haxe.org/manual/lf-iterators.html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Tells if structure `o` has a field named `field`. - - This is only guaranteed to work for anonymous structures. Refer to - `Type.getInstanceFields` for a function supporting class instances. - - If `o` or `field` are null, the result is unspecified. - - - - - - - - - Returns the value of the field named `field` on object `o`. - - If `o` is not an object or has no field named `field`, the result is - null. - - If the field is defined as a property, its accessors are ignored. Refer - to `Reflect.getProperty` for a function supporting property accessors. - - If `field` is null, the result is unspecified. - - (As3) If used on a property field, the getter will be invoked. It is - not possible to obtain the value directly. - - - - - - - - - - Sets the field named `field` of object `o` to value `value`. - - If `o` has no field named `field`, this function is only guaranteed to - work for anonymous structures. - - If `o` or `field` are null, the result is unspecified. - - (As3) If used on a property field, the setter will be invoked. It is - not possible to set the value directly. - - - - - - - - - Returns the value of the field named `field` on object `o`, taking - property getter functions into account. - - If the field is not a property, this function behaves like - `Reflect.field`, but might be slower. - - If `o` or `field` are null, the result is unspecified. - - - - - - - - - - Sets the field named `field` of object `o` to value `value`, taking - property setter functions into account. - - If the field is not a property, this function behaves like - `Reflect.setField`, but might be slower. - - If `field` is null, the result is unspecified. - - - - - - - - - - Call a method with the given object and arguments. - - - - - - - - Returns the fields of structure `o`. - - This method is only guaranteed to work on anonymous structures. Refer to - `Type.getInstanceFields` for a function supporting class instances. - - If `o` is null, the result is unspecified. - - - - - - - - Returns true if `f` is a function, false otherwise. - - If `f` is null, the result is false. - - - - - - - - Compares `a` and `b`. - - If `a` is less than `b`, the result is negative. If `b` is less than - `a`, the result is positive. If `a` and `b` are equal, the result is 0. - - This function is only defined if `a` and `b` are of the same type. - - If that type is a function, the result is unspecified and - `Reflect.compareMethods` should be used instead. - - For all other types, the result is 0 if `a` and `b` are equal. If they - are not equal, the result depends on the type and is negative if: - - - Numeric types: a is less than b - - String: a is lexicographically less than b - - Other: unspecified - - If `a` and `b` are null, the result is 0. If only one of them is null, - the result is unspecified. - - - - - - - - Compares the functions `f1` and `f2`. - - If `f1` or `f2` are not functions, the result is unspecified. - - Otherwise the result is true if `f1` and the `f2` are physically equal, - false otherwise. - - - - - - - - ` - - `Enum` - - Otherwise, including if `v` is null, the result is false.]]> - - - - - - - Tells if `v` is an enum value. - - The result is true if `v` is of type EnumValue, i.e. an enum - constructor. - - Otherwise, including if `v` is null, the result is false. - - - - - - - - - Removes the field named `field` from structure `o`. - - This method is only guaranteed to work on anonymous structures. - - If `o` or `field` are null, the result is unspecified. - - - - - - - Copies the fields of structure `o`. - - This is only guaranteed to work on anonymous structures. - - If `o` is null, the result is unspecified. - - - - - - - - - - - Transform a function taking an array of arguments into a function that can - be called with any number of arguments. - - - - - - - - - The Reflect API is a way to manipulate values dynamically through an - abstract interface in an untyped manner. Use with care. - - @see http://haxe.org/manual/std-reflection.html - - - - - - - - - Returns the String corresponding to the character code `code`. - - If `code` is negative or has another invalid value, the result is - unspecified. - - - - The number of characters in `this` String. - - - - Returns a String where all characters of `this` String are upper case. - - Affects the characters `a-z`. Other characters remain unchanged. - - - - Returns a String where all characters of `this` String are lower case. - - Affects the characters `A-Z`. Other characters remain unchanged. - - - - - - - Returns the character at position `index` of `this` String. - - If `index` is negative or exceeds `this.length`, the empty String `""` - is returned. - - - - - - - - Returns the position of the leftmost occurence of `str` within `this` - String. - - If `startIndex` is given, the search is performed within the substring - of `this` String starting from `startIndex`. Otherwise the search is - performed within `this` String. In either case, the returned position - is relative to the beginning of `this` String. - - If `str` cannot be found, -1 is returned. - - - - - - - - Returns the position of the rightmost occurence of `str` within `this` - String. - - If `startIndex` is given, the search is performed within the substring - of `this` String from 0 to `startIndex`. Otherwise the search is - performed within `this` String. In either case, the returned position - is relative to the beginning of `this` String. - - If `str` cannot be found, -1 is returned. - - - - - - - Splits `this` String at each occurence of `delimiter`. - - If `this` String is the empty String `""`, the result is not consistent - across targets and may either be `[]` (on Js, Cpp) or `[""]`. - - If `delimiter` is the empty String `""`, `this` String is split into an - Array of `this.length` elements, where the elements correspond to the - characters of `this` String. - - If `delimiter` is not found within `this` String, the result is an Array - with one element, which equals `this` String. - - If `delimiter` is null, the result is unspecified. - - Otherwise, `this` String is split into parts at each occurence of - `delimiter`. If `this` String starts (or ends) with `delimiter`, the - result `Array` contains a leading (or trailing) empty String `""` element. - Two subsequent delimiters also result in an empty String `""` element. - - - - Returns the String itself. - - - - - - - - Returns the part of `this` String from `startIndex` to but not including `endIndex`. - - If `startIndex` or `endIndex` are negative, 0 is used instead. - - If `startIndex` exceeds `endIndex`, they are swapped. - - If the (possibly swapped) `endIndex` is omitted or exceeds - `this.length`, `this.length` is used instead. - - If the (possibly swapped) `startIndex` exceeds `this.length`, the empty - String `""` is returned. - - - - - - - - Returns the character code at position `index` of `this` String. - - If `index` is negative or exceeds `this.length`, `null` is returned. - - To obtain the character code of a single character, `"x".code` can be - used instead to inline the character code at compile time. Note that - this only works on String literals of length 1. - - - - - - - - - Returns `len` characters of `this` String, starting at position `pos`. - - If `len` is omitted, all characters from position `pos` to the end of - `this` String are included. - - If `pos` is negative, its value is calculated from the end of `this` - String by `this.length + pos`. If this yields a negative value, 0 is - used instead. - - If the calculated position + `len` exceeds `this.length`, the characters - from that position to the end of `this` String are returned. - - If `len` is negative, the result is unspecified. - - - - - - - Creates a copy from a given String. - - The basic String class. - - A Haxe String is immutable, it is not possible to modify individual - characters. No method of this class changes the state of `this` String. - - Strings can be constructed using the String literal syntax `"string value"`. - - String can be concatenated by using the `+` operator. If an operand is not a - String, it is passed through `Std.string()` first. - - @see http://haxe.org/manual/std-String.html - - - - - - - - - - - Tells if a value `v` is of the type `t`. Returns `false` if `v` or `t` are null. - - - - - - - - - Checks if object `value` is an instance of class `c`. - - Compiles only if the class specified by `c` can be assigned to the type - of `value`. - - This method checks if a downcast is possible. That is, if the runtime - type of `value` is assignable to the class specified by `c`, `value` is - returned. Otherwise null is returned. - - This method is not guaranteed to work with interfaces or core types such - as `String`, `Array` and `Date`. - - If `value` is null, the result is null. If `c` is null, the result is - unspecified. - - - - - - - - Converts any value to a String. - - If `s` is of `String`, `Int`, `Float` or `Bool`, its value is returned. - - If `s` is an instance of a class and that class or one of its parent classes has - a `toString` method, that method is called. If no such method is present, the result - is unspecified. - - If `s` is an enum constructor without argument, the constructor's name is returned. If - arguments exists, the constructor's name followed by the String representations of - the arguments is returned. - - If `s` is a structure, the field names along with their values are returned. The field order - and the operator separating field names and values are unspecified. - - If s is null, "null" is returned. - - - - - - - Converts a `Float` to an `Int`, rounded towards 0. - - If `x` is outside of the signed Int32 range, or is `NaN`, `NEGATIVE_INFINITY` or `POSITIVE_INFINITY`, the result is unspecified. - - - - - - - - Converts a `String` to an `Int`. - - Leading whitespaces are ignored. - - If `x` starts with 0x or 0X, hexadecimal notation is recognized where the following digits may - contain 0-9 and A-F. - - Otherwise `x` is read as decimal number with 0-9 being allowed characters. `x` may also start with - a - to denote a negative value. - - In decimal mode, parsing continues until an invalid character is detected, in which case the - result up to that point is returned. For hexadecimal notation, the effect of invalid characters - is unspecified. - - Leading 0s that are not part of the 0x/0X hexadecimal notation are ignored, which means octal - notation is not supported. - - If the input cannot be recognized, the result is `null`. - - - - - - - - Converts a `String` to a `Float`. - - The parsing rules for `parseInt` apply here as well, with the exception of invalid input - resulting in a `NaN` value instead of null. - - Additionally, decimal notation may contain a single `.` to denote the start of the fractions. - - - - - - - - - The Std class provides standard methods for manipulating basic types. - - - - - - - - The standard `Void` type. Only `null` values can be of the type `Void`. - - @see http://haxe.org/manual/types-void.html - - - - - ` can be used instead. - - `Std.int` converts a `Float` to an `Int`, rounded towards 0. - `Std.parseFloat` converts a `String` to a `Float`. - - @see http://haxe.org/manual/types-basic-types.html - @see http://haxe.org/manual/types-nullability.html]]> - - - - - - - - - - ` can be used instead. - - `Std.int` converts a `Float` to an `Int`, rounded towards 0. - `Std.parseInt` converts a `String` to an `Int`. - - @see http://haxe.org/manual/types-basic-types.html - @see http://haxe.org/manual/std-math-integer-math.html - @see http://haxe.org/manual/types-nullability.html]]> - - - - - - - - - `Null` can be useful in two cases. In order to document some methods - that accept or can return a `null` value, or for the Flash compiler and AS3 - generator to distinguish between base values that can be `null` and others that - can't. - - @see http://haxe.org/manual/types-nullability.html - - - - ` can be used instead. - - @see http://haxe.org/manual/types-bool.html - @see http://haxe.org/manual/types-nullability.html]]> - - - - - - - - - `Dynamic` is a special type which is compatible with all other types. - - Use of `Dynamic` should be minimized as it prevents several compiler - checks and optimizations. - - @see http://haxe.org/manual/types-dynamic.html - - - - - - - - - - Returns the current item of the `Iterator` and advances to the next one. - - This method is not required to check `hasNext()` first. A call to this - method while `hasNext()` is `false` yields unspecified behavior. - - On the other hand, iterators should not require a call to `hasNext()` - before the first call to `next()` if an element is available. - - - - Returns `false` if the iteration is complete, `true` otherwise. - - Usually iteration is considered to be complete if all elements of the - underlying data structure were handled through calls to `next()`. However, - in custom iterators any logic may be used to determine the completion - state. - - - An `Iterator` is a structure that permits iteration over elements of type `T`. - - Any class with matching `hasNext()` and `next()` fields is considered an `Iterator` - and can then be used e.g. in `for`-loops. This makes it easy to implement - custom iterators. - - @see http://haxe.org/manual/lf-iterators.html - - - - An `Iterable` is a data structure which has an `iterator()` method. - See `Lambda` for generic functions on iterable structures. - - @see http://haxe.org/manual/lf-iterators.html - - `ArrayAccess` is used to indicate a class that can be accessed using brackets. - The type parameter represents the type of the elements stored. - - This interface should be used for externs only. Haxe does not support custom - array access on classes. However, array access can be implemented for - abstract types. - - @see http://haxe.org/manual/types-abstract-array-access.html - - - - - The length of `this` StringBuf in characters. - - - - - - - - Appends the representation of `x` to `this` StringBuf. - - The exact representation of `x` may vary per platform. To get more - consistent behavior, this function should be called with - Std.string(x). - - If `x` is null, the String "null" is appended. - - - - - - - Appends the character identified by `c` to `this` StringBuf. - - If `c` is negative or has another invalid value, the result is - unspecified. - - - - - - - - - Appends a substring of `s` to `this` StringBuf. - - This function expects `pos` and `len` to describe a valid substring of - `s`, or else the result is unspecified. To get more robust behavior, - `this.add(s.substr(pos,len))` can be used instead. - - If `s` or `pos` are null, the result is unspecified. - - If `len` is omitted or null, the substring ranges from `pos` to the end - of `s`. - - - - Returns the content of `this` StringBuf as String. - - The buffer is not emptied by this operation. - - - - Creates a new StringBuf instance. - - This may involve initialization of the internal buffer. - - A String buffer is an efficient way to build a big string by appending small - elements together. - - Its cross-platform implementation uses String concatenation internally, but - StringBuf may be optimized for different targets. - - Unlike String, an instance of StringBuf is not immutable in the sense that - it can be passed as argument to functions which modify it by appending more - values. However, the internal buffer cannot be modified. - - - - - - - - - Encode an URL by using the standard format. - - - - - - - - Decode an URL using the standard format. - - - - - - - - ` becomes `>`; - - If `quotes` is true, the following characters are also replaced: - - - `"` becomes `"`; - - `'` becomes `'`;]]> - - - - - - - ` - - `"` becomes `"` - - `'` becomes `'`]]> - - - - - - - - Tells if the string `s` starts with the string `start`. - - If `start` is `null`, the result is unspecified. - - If `start` is the empty String `""`, the result is true. - - - - - - - - Tells if the string `s` ends with the string `end`. - - If `end` is `null`, the result is unspecified. - - If `end` is the empty String `""`, the result is true. - - - - - - - - Tells if the character in the string `s` at position `pos` is a space. - - A character is considered to be a space character if its character code - is 9,10,11,12,13 or 32. - - If `s` is the empty String `""`, or if pos is not a valid position within - `s`, the result is false. - - - - - - - Removes leading space characters of `s`. - - This function internally calls `isSpace()` to decide which characters to - remove. - - If `s` is the empty String `""` or consists only of space characters, the - result is the empty String `""`. - - - - - - - Removes trailing space characters of `s`. - - This function internally calls `isSpace()` to decide which characters to - remove. - - If `s` is the empty String `""` or consists only of space characters, the - result is the empty String `""`. - - - - - - - Removes leading and trailing space characters of `s`. - - This is a convenience function for `ltrim(rtrim(s))`. - - - - - - - - - Concatenates `c` to `s` until `s.length` is at least `l`. - - If `c` is the empty String `""` or if `l` does not exceed `s.length`, - `s` is returned unchanged. - - If `c.length` is 1, the resulting String length is exactly `l`. - - Otherwise the length may exceed `l`. - - If `c` is null, the result is unspecified. - - - - - - - - - Appends `c` to `s` until `s.length` is at least `l`. - - If `c` is the empty String `""` or if `l` does not exceed `s.length`, - `s` is returned unchanged. - - If `c.length` is 1, the resulting String length is exactly `l`. - - Otherwise the length may exceed `l`. - - If `c` is null, the result is unspecified. - - - - - - - - - Replace all occurences of the String `sub` in the String `s` by the - String `by`. - - If `sub` is the empty String `""`, `by` is inserted after each character - of `s`. If `by` is also the empty String `""`, `s` remains unchanged. - - This is a convenience function for `s.split(sub).join(by)`. - - If `sub` or `by` are null, the result is unspecified. - - - - - - - - Encodes `n` into a hexadecimal representation. - - If `digits` is specified, the resulting String is padded with "0" until - its `length` equals `digits`. - - - - - - - - - Returns the character code at position `index` of String `s`, or an - end-of-file indicator at if `position` equals `s.length`. - - This method is faster than `String.charCodeAt()` on some platforms, but - the result is unspecified if `index` is negative or greater than - `s.length`. - - End of file status can be checked by calling `StringTools.isEof()` with - the returned value as argument. - - This operation is not guaranteed to work if `s` contains the `\0` - character. - - - - - - - - - - - - - - Returns a String that can be used as a single command line argument - on Unix. - The input will be quoted, or escaped if necessary. - - - - ".code, "&".code, "|".code, "\n".code, "\r".code]]]> - Character codes of the characters that will be escaped by `quoteWinArg(_, true)`. - - - - - - - - Returns a String that can be used as a single command line argument - on Windows. - The input will be quoted, or escaped if necessary, such that the output - will be parsed as a single argument using the rule specified in - http://msdn.microsoft.com/en-us/library/ms880421 - - Examples: - ``` - quoteWinArg("abc") == "abc"; - quoteWinArg("ab c") == '"ab c"'; - ``` - - This class provides advanced methods on Strings. It is ideally used with - `using StringTools` and then acts as an [extension](http://haxe.org/manual/lf-static-extension.html) - to the `String` class. - - If the first argument to any of the methods is null, the result is - unspecified. - - - - - - - - - - - - - - - - - - - Returns the class of `o`, if `o` is a class instance. - - If `o` is null or of a different type, null is returned. - - In general, type parameter information cannot be obtained at runtime. - - - - - - - - `. - - If `o` is null, null is returned. - - In general, type parameter information cannot be obtained at runtime.]]> - - - - - - - - Returns the super-class of class `c`. - - If `c` has no super class, null is returned. - - If `c` is null, the result is unspecified. - - In general, type parameter information cannot be obtained at runtime. - - - - - - - - Returns the name of class `c`, including its path. - - If `c` is inside a package, the package structure is returned dot- - separated, with another dot separating the class name: - `pack1.pack2.(...).packN.ClassName` - If `c` is a sub-type of a Haxe module, that module is not part of the - package structure. - - If `c` has no package, the class name is returned. - - If `c` is null, the result is unspecified. - - The class name does not include any type parameters. - - - - - - - - Returns the name of enum `e`, including its path. - - If `e` is inside a package, the package structure is returned dot- - separated, with another dot separating the enum name: - `pack1.pack2.(...).packN.EnumName` - If `e` is a sub-type of a Haxe module, that module is not part of the - package structure. - - If `e` has no package, the enum name is returned. - - If `e` is null, the result is unspecified. - - The enum name does not include any type parameters. - - - - - - - - Resolves a class by name. - - If `name` is the path of an existing class, that class is returned. - - Otherwise null is returned. - - If `name` is null or the path to a different type, the result is - unspecified. - - The class name must not include any type parameters. - - - - - - - - Resolves an enum by name. - - If `name` is the path of an existing enum, that enum is returned. - - Otherwise null is returned. - - If `name` is null the result is unspecified. - - If `name` is the path to a different type, null is returned. - - The enum name must not include any type parameters. - - - - - - - - - Creates an instance of class `cl`, using `args` as arguments to the - class constructor. - - This function guarantees that the class constructor is called. - - Default values of constructors arguments are not guaranteed to be - taken into account. - - If `cl` or `args` are null, or if the number of elements in `args` does - not match the expected number of constructor arguments, or if any - argument has an invalid type, or if `cl` has no own constructor, the - result is unspecified. - - In particular, default values of constructor arguments are not - guaranteed to be taken into account. - - - - - - - - Creates an instance of class `cl`. - - This function guarantees that the class constructor is not called. - - If `cl` is null, the result is unspecified. - - - - - - - - - Creates an instance of enum `e` by calling its constructor `constr` with - arguments `params`. - - If `e` or `constr` is null, or if enum `e` has no constructor named - `constr`, or if the number of elements in `params` does not match the - expected number of constructor arguments, or if any argument has an - invalid type, the result is unspecified. - - - - - - - - - - Creates an instance of enum `e` by calling its constructor number - `index` with arguments `params`. - - The constructor indices are preserved from Haxe syntax, so the first - declared is index 0, the next index 1 etc. - - If `e` or `constr` is null, or if enum `e` has no constructor named - `constr`, or if the number of elements in `params` does not match the - expected number of constructor arguments, or if any argument has an - invalid type, the result is unspecified. - - - - - - - - Returns a list of the instance fields of class `c`. - - This only includes fields which are known at compile-time. In - particular, using getInstanceFields(getClass(obj)) will not include - any fields which were added to obj at runtime. - - The order of the fields in the returned Array is unspecified. - - If `c` is null, the result is unspecified. - - (As3) This method only returns instance fields that are public. - - - - - - - Returns a list of static fields of class `c`. - - This does not include static fields of parent classes. - - The order of the fields in the returned Array is unspecified. - - If `c` is null, the result is unspecified. - - (As3) This method only returns class fields that are public. - - - - - - - Returns a list of the names of all constructors of enum `e`. - - The order of the constructor names in the returned Array is preserved - from the original syntax. - - If `c` is null, the result is unspecified. - - - - - - - - Returns the runtime type of value `v`. - - The result corresponds to the type `v` has at runtime, which may vary - per platform. Assumptions regarding this should be minimized to avoid - surprises. - - - - - - - - - Recursively compares two enum instances `a` and `b` by value. - - Unlike `a == b`, this function performs a deep equality check on the - arguments of the constructors, if exists. - - If `a` or `b` are null, the result is unspecified. - - - - - - - - Returns the constructor name of enum instance `e`. - - The result String does not contain any constructor arguments. - - If `e` is null, the result is unspecified. - - - - - - - - Returns a list of the constructor arguments of enum instance `e`. - - If `e` has no arguments, the result is []. - - Otherwise the result are the values that were used as arguments to `e`, - in the order of their declaration. - - If `e` is null, the result is unspecified. - - - - - - - - Returns the index of enum instance `e`. - - This corresponds to the original syntactic position of `e`. The index of - the first declared constructor is 0, the next one is 1 etc. - - If `e` is null, the result is unspecified. - - - - - - - - Returns a list of all constructors of enum `e` that require no - arguments. - - This may return the empty Array `[]` if all constructors of `e` require - arguments. - - Otherwise an instance of `e` constructed through each of its non- - argument constructors is returned, in the order of the constructor - declaration. - - If `e` is null, the result is unspecified. - - The Haxe Reflection API allows retrieval of type information at runtime. - - This class complements the more lightweight Reflect class, with a focus on - class and enum instances. - - @see http://haxe.org/manual/types.html - @see http://haxe.org/manual/std-reflection.html - - - - - - - - - - - "Error" - - - - - "Error" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - "express" - - - - - - - - - - - cast "mount" - - - - - - - - - - - - cast "mount" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - `IEventEmitter` interface is used as "any EventEmitter". - - See `EventEmitter` for actual class documentation. - - - - - - `setMaxListeners` sets the maximum on a per-instance basis. - This class property lets you set it for all EventEmitter instances, - current and future, effective immediately. Use with care. - - Note that `setMaxListeners` still has precedence over `defaultMaxListeners`. - - - - - - - - Return the number of listeners for a given event. - - - - - - - - Adds a `listener` to the end of the listeners array for the specified `event`. - - - - - - - - - - - - - Adds a one time `listener` for the `event`. - - This listener is invoked only the next time the event is fired, after which it is removed. - - - - - - - - Remove a `listener` from the listener array for the specified `event`. - - Caution: changes array indices in the listener array behind the listener. - - - - - - - Removes all listeners, or those of the specified `event`. - - - - - - - By default `EventEmitter`s will print a warning if more than 10 listeners are added for a particular event. - This is a useful default which helps finding memory leaks. - - Obviously not all Emitters should be limited to 10. This function allows that to be increased. - Set to zero for unlimited. - - - - - - - Returns an array of listeners for the specified event. - - - - - - - - Execute each of the listeners in order with the supplied arguments. - Returns true if event had listeners, false otherwise. - - - All objects which emit events are instances of `EventEmitter`. - - Typically, event names are represented by a camel-cased string, however, - there aren't any strict restrictions on that, as any string will be accepted. - - Functions can then be attached to objects, to be executed when an event is emitted. - These functions are called listeners. - - When an `EventEmitter` instance experiences an error, the typical action is to emit an 'error' event. - Error events are treated as a special case in node. If there is no listener for it, then the default action - is to print a stack trace and exit the program. - - All `EventEmitter`s emit the event `newListener` when new listeners are added - and `removeListener` when a listener is removed. - - "events" - "EventEmitter" - - - - `IStream` interface is used as "any Stream". - - See `Stream` for actual class. - - - - - - Base class for all streams. - "stream" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - `IReadable` interface is used as "any Readable". - - See `Readable` for actual class documentation. - - - - - - - - - - - - - The `read` method pulls some data out of the internal buffer and returns it. - If there is no data available, then it will return null. - - If you pass in a `size` argument, then it will return that many bytes. - If `size` bytes are not available, then it will return null. - - If you do not specify a `size` argument, then it will return all the data in the internal buffer. - - This method should only be called in non-flowing mode. - In flowing-mode, this method is called automatically until the internal buffer is drained. - - - - - - - Call this function to cause the stream to return strings of the specified encoding instead of `Buffer` objects. - For example, if you do `setEncoding('utf8')`, then the output data will be interpreted as UTF-8 data, - and returned as strings. If you do `setEncoding('hex')`, then the data will be encoded in hexadecimal string format. - - This properly handles multi-byte characters that would otherwise be potentially mangled if you simply pulled - the `Buffer`s directly and called `buf.toString(encoding)` on them. - - If you want to read the data as strings, always use this method. - - - - This method will cause the readable stream to resume emitting 'data' events. - - This method will switch the stream into flowing-mode. - If you do not want to consume the data from a stream, but you do want to get to its `end` event, - you can call `resume` to open the flow of data. - - - - This method will cause a stream in flowing-mode to stop emitting 'data' events. - - Any data that becomes available will remain in the internal buffer. - - This method is only relevant in flowing mode. When called on a non-flowing stream, - it will switch into flowing mode, but remain paused. - - - - - - - - - - - This method pulls all the data out of a readable stream, and writes it to the supplied destination, - automatically managing the flow so that the destination is not overwhelmed by a fast readable stream. - - Multiple destinations can be piped to safely. - - This function returns the destination stream, so you can set up pipe chains. - - By default `end` is called on the destination when the source stream emits 'end', - so that destination is no longer writable. Pass `{end: false}` as `options` - to keep the destination stream open. - - Note that `Process.stderr` and `Process.stdout` are never closed until the process exits, - regardless of the specified options. - - - - - - - This method will remove the hooks set up for a previous `pipe` call. - - If the `destination` is not specified, then all pipes are removed. - - If the `destination` is specified, but no pipe is set up for it, then this is a no-op. - - - This method will remove the hooks set up for a previous `pipe` call. - - If the `destination` is not specified, then all pipes are removed. - - If the `destination` is specified, but no pipe is set up for it, then this is a no-op. - - - - - - - - This is useful in certain cases where a stream is being consumed by a parser, - which needs to "un-consume" some data that it has optimistically pulled out of the source, - so that the stream can be passed on to some other party. - - If you find that you must often call `unshift` in your programs, - consider implementing a `Transform` stream instead. - - - - - - This is useful in certain cases where a stream is being consumed by a parser, - which needs to "un-consume" some data that it has optimistically pulled out of the source, - so that the stream can be passed on to some other party. - - If you find that you must often call `unshift` in your programs, - consider implementing a `Transform` stream instead. - - - - - - - - Versions of Node prior to v0.10 had streams that did not implement the entire Streams API as it is today. - - If you are using an older Node library that emits 'data' events and has a 'pause' method that is advisory only, - then you can use the `wrap` method to create a `Readable` stream that uses the old stream as its data source. - - <_read set="method"> - - - - - - - - - - - - - - - - - - - The Readable stream interface is the abstraction for a source of data that you are reading from. - In other words, data comes out of a Readable stream. - - A Readable stream will not start emitting data until you indicate that you are ready to receive it. - - Readable streams have two "modes": a flowing mode and a non-flowing mode. - When in flowing mode, data is read from the underlying system and provided to your program as fast as possible. - In non-flowing mode, you must explicitly call `read` to get chunks of data out. - - Examples of readable streams include: - - http responses, on the client - - http requests, on the server - - fs read streams - - zlib streams - - crypto streams - - tcp sockets - - child process stdout and stderr - - process.stdin - - "stream" - "Readable" - - - - - - - In case of server request, the HTTP version sent by the client. - In the case of client response, the HTTP version of the connected-to server. - Probably either '1.1' or '1.0'. - - - - HTTP Version first integer - - - - HTTP Version second integer - - - - The request/response headers object. - Read only map of header names and values. Header names are lower-cased - - - - The request/response trailers object. - Only populated after the 'end' event. - - - - - - - - Calls `setTimeout` on the `socket` object. - - - - Only valid for request obtained from `Server`. - - The request method as a string. - Read only. Example: 'GET', 'DELETE'. - - - - Only valid for request obtained from `Server`. - - Request URL string. This contains only the URL that is present in the actual HTTP request. - - - - Only valid for response obtained from `ClientRequest`. - The 3-digit HTTP response status code. E.G. 404. - - - - The `Socket` object associated with the connection. - - - - Alias for `socket`. - - An `IncomingMessage` object is created by `Server` or `ClientRequest` - and passed as the first argument to the 'request' and 'response' event respectively. - It may be used to access response status, headers and data. - - "http" - "IncomingMessage" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Writable interface used for type parameter constraints. - See `Writable` for actual class documentation. - - - - - - - - - - - - This method writes some data to the underlying system, - and calls the supplied callback once the data has been fully handled. - - The return value indicates if you should continue writing right now. If the data had to be buffered internally, - then it will return `false`. Otherwise, it will return `true`. - - This return value is strictly advisory. You MAY continue to write, even if it returns `false`. - However, writes will be buffered in memory, so it is best not to do this excessively. - Instead, wait for the `drain` event before writing more data. - - - - - - - - This method writes some data to the underlying system, - and calls the supplied callback once the data has been fully handled. - - The return value indicates if you should continue writing right now. If the data had to be buffered internally, - then it will return `false`. Otherwise, it will return `true`. - - This return value is strictly advisory. You MAY continue to write, even if it returns `false`. - However, writes will be buffered in memory, so it is best not to do this excessively. - Instead, wait for the `drain` event before writing more data. - - - - - - - - This method writes some data to the underlying system, - and calls the supplied callback once the data has been fully handled. - - The return value indicates if you should continue writing right now. If the data had to be buffered internally, - then it will return `false`. Otherwise, it will return `true`. - - This return value is strictly advisory. You MAY continue to write, even if it returns `false`. - However, writes will be buffered in memory, so it is best not to do this excessively. - Instead, wait for the `drain` event before writing more data. - - - - - - - - - - - Call this method when no more data will be written to the stream. - If supplied, the callback is attached as a listener on the `finish` event. - - Calling `write()` after calling `end()` will raise an error. - - - - - - - Call this method when no more data will be written to the stream. - If supplied, the callback is attached as a listener on the `finish` event. - - Calling `write()` after calling `end()` will raise an error. - - - - - - - - Call this method when no more data will be written to the stream. - If supplied, the callback is attached as a listener on the `finish` event. - - Calling `write()` after calling `end()` will raise an error. - - - - - - - - Call this method when no more data will be written to the stream. - If supplied, the callback is attached as a listener on the `finish` event. - - Calling `write()` after calling `end()` will raise an error. - - - - - - Terminal write streams (i.e. process.stdout) have this property set to true. - It is false for any other write streams. - - <_write set="method"> - - - - - - - - - - <_write set="method"> - - - - - - - - - - - - - - The Writable stream interface is an abstraction for a destination that you are writing data to. - - Examples of writable streams include: - - http requests, on the client - - http responses, on the server - - fs write streams - - zlib streams - - crypto streams - - tcp sockets - - child process stdin - - process.stdout, process.stderr - - "stream" - "Writable" - - - - - - - Sends a HTTP/1.1 100 Continue message to the client, indicating that the request body should be sent. - See the 'checkContinue' event on `Server`. - - - - - - - - - Sends a response header to the request. - The status code is a 3-digit HTTP status code, like 404. - The last argument, `headers`, are the response headers. - Optionally one can give a human-readable `reasonPhrase` as the second argument. - - This method must only be called once on a message and it must be called before `end` is called. - - If you call `write` or `end` before calling this, the implicit/mutable headers - will be calculated and call this function for you. - - Note: that Content-Length is given in bytes not characters. - - - - - - - Sends a response header to the request. - The status code is a 3-digit HTTP status code, like 404. - The last argument, `headers`, are the response headers. - Optionally one can give a human-readable `reasonPhrase` as the second argument. - - This method must only be called once on a message and it must be called before `end` is called. - - If you call `write` or `end` before calling this, the implicit/mutable headers - will be calculated and call this function for you. - - Note: that Content-Length is given in bytes not characters. - - - - - - - - - Sets the `Socket`'s timeout value to `msecs`. - If a `callback` is provided, then it is added as a listener on the 'timeout' event on the response object. - - If no 'timeout' listener is added to the request, the response, or the server, - then sockets are destroyed when they time out. If you assign a handler on the request, - the response, or the server's 'timeout' events, then it is your responsibility to handle timed out sockets. - - - - When using implicit headers (not calling `writeHead` explicitly), this property controls the status code - that will be sent to the client when the headers get flushed. - - - - True if headers were sent, false otherwise. - - - - When true, the Date header will be automatically generated and sent in the response - if it is not already present in the headers. - Defaults to true. - - This should only be disabled for testing; HTTP requires the Date header in responses. - - - - - - - Reads out a header that's already been queued but not sent to the client. - Note that the name is case insensitive. - This can only be called before headers get implicitly flushed. - - - - - - - - Sets a single header value for implicit headers. - If this header already exists in the to-be-sent headers, its value will be replaced. - Use an array of strings here if you need to send multiple headers with the same name. - - - - - - - Sets a single header value for implicit headers. - If this header already exists in the to-be-sent headers, its value will be replaced. - Use an array of strings here if you need to send multiple headers with the same name. - - - - - - - - Removes a header that's queued for implicit sending. - - - - - - - This method adds HTTP trailing headers (a header but at the end of the message) to the response. - - Trailers will only be emitted if chunked encoding is used for the response; - if it is not (e.g., if the request was HTTP/1.0), they will be silently discarded. - - Note that HTTP requires the 'Trailer' header to be sent if you intend to emit trailers, - with a list of the header fields in its value. - - - - - - This method adds HTTP trailing headers (a header but at the end of the message) to the response. - - Trailers will only be emitted if chunked encoding is used for the response; - if it is not (e.g., if the request was HTTP/1.0), they will be silently discarded. - - Note that HTTP requires the 'Trailer' header to be sent if you intend to emit trailers, - with a list of the header fields in its value. - - - This object is created internally by a HTTP server--not by the user. - It is passed as the second parameter to the 'request' event. - - "http" - "ServerResponse" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - "express" - "Router" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - cast "allow" - - - - - - - - cast "deny" - - - - - - - - cast "ignore" - - - - - - - - - - - - cast "allow" - - - - - - - - cast "deny" - - - - - - - - cast "ignore" - - - - - - - - - This type unifies with any function type. - - It is intended to be used as a type parameter constraint. If used as a real - type, the underlying type will be `Dynamic`. - - - - - - - This type unifies with an enum instance if all constructors of the enum - require no arguments. - - It is intended to be used as a type parameter constraint. If used as a real - type, the underlying type will be `Dynamic`. - - - - - - `, A must be explicitly constrained to - `Constructible` as well. - - It is intended to be used as a type parameter constraint. If used as a real - type, the underlying type will be `Dynamic`.]]> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - DynamicAccess is an abstract type for working with anonymous structures - that are intended to hold collections of objects by the string key. - - For example, these types of structures are often created from JSON. - - Basically, it wraps `Reflect` calls in a `Map`-like interface. - - <_new public="1" get="inline" set="null" line="37" static="1"> - - - Creates a new structure. - - - - - - - - - - - - - Returns a value by specified `key`. - - If the structure does not contain the given key, null is returned. - - If `key` is null, the result is unspecified. - - - - - - - - - - - - - - Sets a `value` for a specified `key`. - - If the structure contains the given key, its value will be overwritten. - - Returns the given value. - - If `key` is null, the result is unspecified. - - - - - - - - - Tells if the structure contains a specified `key`. - - If `key` is null, the result is unspecified. - - - - - - - - - Removes a specified `key` from the structure. - - Returns true, if `key` was present in structure, or false otherwise. - - If `key` is null, the result is unspecified. - - - - - - - - Returns an array of `keys` in a structure. - - - - - <_new public="1" get="inline" set="null" line="37" static="1"> - - - Creates a new structure. - - - - - - - - - - - - - Returns a value by specified `key`. - - If the structure does not contain the given key, null is returned. - - If `key` is null, the result is unspecified. - - - - - - - - - - - - - - Sets a `value` for a specified `key`. - - If the structure contains the given key, its value will be overwritten. - - Returns the given value. - - If `key` is null, the result is unspecified. - - - - - - - - - Tells if the structure contains a specified `key`. - - If `key` is null, the result is unspecified. - - - - - - - - - Removes a specified `key` from the structure. - - Returns true, if `key` was present in structure, or false otherwise. - - If `key` is null, the result is unspecified. - - - - - - - - Returns an array of `keys` in a structure. - - - - - - - - - Returns the name of enum `e`, including its path. - - If `e` is inside a package, the package structure is returned dot- - separated, with another dot separating the enum name: - pack1.pack2.(...).packN.EnumName - If `e` is a sub-type of a Haxe module, that module is not part of the - package structure. - - If `e` has no package, the enum name is returned. - - If `e` is `null`, the result is unspecified. - - The enum name does not include any type parameters. - - - - - - - - - Creates an instance of enum `e` by calling its constructor `constr` with - arguments `params`. - - If `e` or `constr` is `null`, or if enum `e` has no constructor named - `constr`, or if the number of elements in `params` does not match the - expected number of constructor arguments, or if any argument has an - invalid type, the result is unspecified. - - - - - - - - - Creates an instance of enum `e` by calling its constructor number - `index` with arguments `params`. - - The constructor indices are preserved from Haxe syntax, so the first - declared is index 0, the next index 1 etc. - - If `e` or `index` is `null`, or if enum `e` has no constructor - corresponding to index `index`, or if the number of elements in `params` - does not match the expected number of constructor arguments, or if any - argument has an invalid type, the result is unspecified. - - - - - - - Returns a list of all constructors of enum `e` that require no - arguments. - - This may return the empty Array `[]` if all constructors of `e` require - arguments. - - Otherwise an instance of `e` constructed through each of its non- - argument constructors is returned, in the order of the constructor - declaration. - - If `e` is `null`, the result is unspecified. - - - - - - - Returns a list of the names of all constructors of enum `e`. - - The order of the constructor names in the returned Array is preserved - from the original syntax. - - If `c` is `null`, the result is unspecified. - - This class provides advanced methods on enums. It is ideally used with - `using EnumTools` and then acts as an - [extension](http://haxe.org/manual/lf-static-extension.html) to the - `enum` types. - - If the first argument to any of the methods is null, the result is - unspecified. - - - - - - - - - Recursively compares two enum instances `a` and `b` by value. - - Unlike `a == b`, this function performs a deep equality check on the - arguments of the constructors (if there are any). - - If `a` or `b` are `null`, the result is unspecified. - - - - - - - Returns the constructor name of enum instance `e`. - - The result String does not contain any constructor arguments. - - If `e` is `null`, the result is unspecified. - - - - - - - Returns a list of the constructor arguments of enum instance `e`. - - If `e` has no arguments, the result is `[]`. - - Otherwise the result are the values that were used as arguments to `e`, - in the order of their declaration. - - If `e` is `null`, the result is unspecified. - - - - - - - Returns the index of enum instance `e`. - - This corresponds to the original syntactic position of `e`. The index of - the first declared constructor is 0, the next one is 1 etc. - - If `e` is `null`, the result is unspecified. - - - - - - - - Matches enum instance `e` against pattern `pattern`, returning `true` if - matching succeeded and `false` otherwise. - - Example usage: - - ```haxe - if (e.match(pattern)) { - // codeIfTrue - } else { - // codeIfFalse - } - ``` - - This is equivalent to the following code: - - ```haxe - switch (e) { - case pattern: - // codeIfTrue - case _: - // codeIfFalse - } - ``` - - This method is implemented in the compiler. This definition exists only - for documentation. - - This class provides advanced methods on enum values. It is ideally used with - `using EnumValueTools` and then acts as an - [extension](http://haxe.org/manual/lf-static-extension.html) to the - `EnumValue` types. - - If the first argument to any of the methods is null, the result is - unspecified. - - - - - - - - - Int32 provides a 32-bit integer with consistent overflow behavior across - all platforms. - - - - - - - - - ++A - - - - - - - - - - A++ - - - - - - - - - - --A - - - - - - - - - - A-- - - - - - - - - - A + B - - - - - - - - - A + B - - - - - - - - - - A - B - - - - - - - - A - B - - - - - - - - A - B - - - - - - - - A * B - - - - - - - - - A * B - - - - - - - - - - - - - - - - - - - - Compare `a` and `b` in unsigned mode. - - - - - - - - - - - - - - - - ++A - - - - - - - - - - A++ - - - - - - - - - - --A - - - - - - - - - - A-- - - - - - - - - - A + B - - - - - - - - - A + B - - - - - - - - - - A - B - - - - - - - - A - B - - - - - - - - A - B - - - - - - - - A * B - - - - - - - - - A * B - - - - - - - - - - - - - - - - - - - - Compare `a` and `b` in unsigned mode. - - - - - - - - - - - - - - A cross-platform signed 64-bit integer. - Int64 instances can be created from two 32-bit words using `Int64.make()`. - - <_new get="inline" set="null" line="35" static="1"> - - - - - - - - - - - - - Makes a copy of `this` Int64. - - - - - - - - Construct an Int64 from two 32-bit words `high` and `low`. - - - - - - - - Returns an Int64 with the value of the Int `x`. - `x` is sign-extended to fill 64 bits. - - - - - - - Returns an Int with the value of the Int64 `x`. - Throws an exception if `x` cannot be represented in 32 bits. - - - - - - - Returns whether the value `val` is of type `haxe.Int64` - - - - - - - "Use high instead" - Returns the high 32-bit word of `x`. - - - - - - - "Use low instead" - Returns the low 32-bit word of `x`. - - - - - - - Returns `true` if `x` is less than zero. - - - - - - - Returns `true` if `x` is exactly zero. - - - - - - - - b`, - or 0 if `a == b`.]]> - - - - - - - - b`, - or 0 if `a == b`.]]> - - - - - - - Returns a signed decimal `String` representation of `x`. - - - - - - - - - - - - - - - - - - - - - - - - - - Performs signed integer divison of `dividend` by `divisor`. - Returns `{ quotient : Int64, modulus : Int64 }`. - - - - - - - -A - Returns the negative of `x`. - - - - - - - - - ++A - - - - - - - - - - A++ - - - - - - - - - - --A - - - - - - - - - - A-- - - - - - - - - - A + B - Returns the sum of `a` and `b`. - - - - - - - - - A + B - - - - - - - - - - A - B - Returns `a` minus `b`. - - - - - - - - A - B - - - - - - - - A - B - - - - - - - - A * B - Returns the product of `a` and `b`. - - - - - - - - - A * B - - - -
    - - - - - - A / B - Returns the quotient of `a` divided by `b`. -
    - - - - - - - A / B - - - - - - - - A / B - - - - - - - - A % B - Returns the modulus of `a` divided by `b`. - - - - - - - - A % B - - - - - - - - A % B - - - - - - - - A == B - Returns `true` if `a` is equal to `b`. - - - - - - - - - A == B - - - - - - - - - - A != B - Returns `true` if `a` is not equal to `b`. - - - - - - - - - A != B - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - B]]> - - - - - - - - B]]> - - - - - - - - B]]> - - - - - - - - = B]]> - - - - - - - - = B]]> - - - - - - - - = B]]> - - - - - - - ~A - Returns the bitwise NOT of `a`. - - - - - - - - - Returns the bitwise AND of `a` and `b`. - - - - - - - - A | B - Returns the bitwise OR of `a` and `b`. - - - - - - - - A ^ B - Returns the bitwise XOR of `a` and `b`. - - - - - - - - - Returns `a` left-shifted by `b` bits. - - - - - - - - > B]]> - Returns `a` right-shifted by `b` bits in signed mode. - `a` is sign-extended. - - - - - - - - >> B]]> - Returns `a` right-shifted by `b` bits in unsigned mode. - `a` is padded with zeroes. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -     -     - - <_new get="inline" set="null" line="35" static="1"> - - - - - - - - - - - - - Makes a copy of `this` Int64. - - - - - - - - Construct an Int64 from two 32-bit words `high` and `low`. - - - - - - - - Returns an Int64 with the value of the Int `x`. - `x` is sign-extended to fill 64 bits. - - - - - - - Returns an Int with the value of the Int64 `x`. - Throws an exception if `x` cannot be represented in 32 bits. - - - - - - - Returns whether the value `val` is of type `haxe.Int64` - - - - - - - "Use high instead" - Returns the high 32-bit word of `x`. - - - - - - - "Use low instead" - Returns the low 32-bit word of `x`. - - - - - - - Returns `true` if `x` is less than zero. - - - - - - - Returns `true` if `x` is exactly zero. - - - - - - - - b`, - or 0 if `a == b`.]]> - - - - - - - - b`, - or 0 if `a == b`.]]> - - - - - - - Returns a signed decimal `String` representation of `x`. - - - - - - - - - - - - - - - - - - - - - - - - - - Performs signed integer divison of `dividend` by `divisor`. - Returns `{ quotient : Int64, modulus : Int64 }`. - - - - - - - -A - Returns the negative of `x`. - - - - - - - - - ++A - - - - - - - - - - A++ - - - - - - - - - - --A - - - - - - - - - - A-- - - - - - - - - - A + B - Returns the sum of `a` and `b`. - - - - - - - - - A + B - - - - - - - - - - A - B - Returns `a` minus `b`. - - - - - - - - A - B - - - - - - - - A - B - - - - - - - - A * B - Returns the product of `a` and `b`. - - - - - - - - - A * B - - - -
    - - - - - - A / B - Returns the quotient of `a` divided by `b`. -
    - - - - - - - A / B - - - - - - - - A / B - - - - - - - - A % B - Returns the modulus of `a` divided by `b`. - - - - - - - - A % B - - - - - - - - A % B - - - - - - - - A == B - Returns `true` if `a` is equal to `b`. - - - - - - - - - A == B - - - - - - - - - - A != B - Returns `true` if `a` is not equal to `b`. - - - - - - - - - A != B - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - B]]> - - - - - - - - B]]> - - - - - - - - B]]> - - - - - - - - = B]]> - - - - - - - - = B]]> - - - - - - - - = B]]> - - - - - - - ~A - Returns the bitwise NOT of `a`. - - - - - - - - - Returns the bitwise AND of `a` and `b`. - - - - - - - - A | B - Returns the bitwise OR of `a` and `b`. - - - - - - - - A ^ B - Returns the bitwise XOR of `a` and `b`. - - - - - - - - - Returns `a` left-shifted by `b` bits. - - - - - - - - > B]]> - Returns `a` right-shifted by `b` bits in signed mode. - `a` is sign-extended. - - - - - - - - >> B]]> - Returns `a` right-shifted by `b` bits in unsigned mode. - `a` is padded with zeroes. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -     - - - * This typedef will fool @:coreApi into thinking that we are using - * the same underlying type, even though it might be different on - * specific platforms. - - - - - - - We also define toString here to ensure we always get a pretty string - when tracing or calling Std.string. This tends not to happen when - toString is only in the abstract. - - - - - - - - - - - - - - Create `Int64` from given string. - - - - - - - Create `Int64` from given float. - - Helper for parsing to `Int64` instances. - - - - - - - - - - - - - PosInfos is a magic type which can be used to generate position information - into the output for debugging use. - - If a function has a final optional argument of this type, i.e. - (..., ?pos:haxe.PosInfos), each call to that function which does not assign - a value to that argument has its position added as call argument. - - This can be used to track positions of calls in e.g. a unit testing - framework. - - - - - How many bytes will be returned when `buffer.inspect()` is called. - This can be overridden by user modules. - Default: 50 - - - - - - - - - - - - Returns `true` if the encoding is a valid encoding argument, or `false` otherwise. - - - - - - - Tests if `obj` is a `Buffer`. - - - - - - - - Gives the actual byte length of a string. - - `encoding` defaults to 'utf8'. - - This is not the same as `String.length` since that - returns the number of characters in a string. - - - - - - - - Returns a buffer which is the result of concatenating all the buffers in the `list` together. - - If the `list` has no items, or if the `totalLength` is 0, then it returns a zero-length buffer. - If the `list` has exactly one item, then the first item of the `list` is returned. - If the `list` has more than one item, then a new `Buffer` is created. - - If `totalLength` is not provided, it is read from the buffers in the `list`. - However, this adds an additional loop to the function, so it is faster to provide the length explicitly. - - - - - - - - "compare" - The same as `buf1.compare(buf2)`. Useful for sorting an Array of Buffers. - - - - The size of the buffer in bytes. - - Note that this is not necessarily the size of the contents. - `length` refers to the amount of memory allocated for the buffer object. - It does not change when the contents of the buffer are changed. - - - - Returns a JSON-representation of the `Buffer` instance. - - - - - - - - Writes `string` to the buffer at `offset` using the given `encoding`. - - `offset` defaults to 0, encoding defaults to 'utf8'. `length` is the number of bytes to write. - - Returns number of octets written. If buffer did not contain enough space to fit the entire `string`, - it will write a partial amount of the `string`. `length` defaults to `buffer.length - offset`. - - The method will not write partial characters. - - - - - - - - - - Writes `string` to the buffer at `offset` using the given `encoding`. - - `offset` defaults to 0, encoding defaults to 'utf8'. `length` is the number of bytes to write. - - Returns number of octets written. If buffer did not contain enough space to fit the entire `string`, - it will write a partial amount of the `string`. `length` defaults to `buffer.length - offset`. - - The method will not write partial characters. - - - - - - - - - Writes `string` to the buffer at `offset` using the given `encoding`. - - `offset` defaults to 0, encoding defaults to 'utf8'. `length` is the number of bytes to write. - - Returns number of octets written. If buffer did not contain enough space to fit the entire `string`, - it will write a partial amount of the `string`. `length` defaults to `buffer.length - offset`. - - The method will not write partial characters. - - - - - - Decodes and returns a string from buffer data encoded with `encoding` (defaults to 'utf8') - beginning at `start` (defaults to 0) and ending at `end` (defaults to `buffer.length`). - - - - - - - - Decodes and returns a string from buffer data encoded with `encoding` (defaults to 'utf8') - beginning at `start` (defaults to 0) and ending at `end` (defaults to `buffer.length`). - - - - - - - - - - - Does copy between buffers. - The source and target regions can be overlapped. - `targetStart` and `sourceStart` default to 0. `sourceEnd` defaults to `buffer.length`. - - - - - - - - Returns a new buffer which references the same memory as the old, - but offset and cropped by the `start` (defaults to 0) and `end` (defaults to `buffer.length`) indexes. - Negative indexes start from the end of the buffer. - - Modifying the new buffer slice will modify memory in the original buffer! - - - - - - - - Reads an unsigned 8 bit integer from the buffer at the specified offset. - - Set `noAssert` to `true` to skip validation of `offset`. - This means that `offset` may be beyond the end of the buffer. Defaults to `false`. - - - - - - - - Reads an unsigned 16 bit integer from the buffer at the specified `offset` with little-endian format. - - Set `noAssert` to `true` to skip validation of `offset`. - This means that `offset` may be beyond the end of the buffer. Defaults to `false`. - - - - - - - - Reads an unsigned 16 bit integer from the buffer at the specified `offset` with big-endian format. - - Set `noAssert` to `true` to skip validation of `offset`. - This means that `offset` may be beyond the end of the buffer. Defaults to `false`. - - - - - - - - Reads an unsigned 32 bit integer from the buffer at the specified `offset` with little-endian format. - - Set `noAssert` to `true` to skip validation of `offset`. - This means that `offset` may be beyond the end of the buffer. Defaults to `false`. - - - - - - - - Reads an unsigned 32 bit integer from the buffer at the specified `offset` with big-endian format. - - Set `noAssert` to `true` to skip validation of `offset`. - This means that `offset` may be beyond the end of the buffer. Defaults to `false`. - - - - - - - - Reads a signed 8 bit integer from the buffer at the specified `offset`. - - Set `noAssert` to `true` to skip validation of `offset`. - This means that `offset` may be beyond the end of the buffer. Defaults to `false`. - - Works as `readUInt8`, except buffer contents are treated as two's complement signed values. - - - - - - - - Reads a signed 16 bit integer from the buffer at the specified `offset` with little-endian format. - - Set `noAssert` to `true` to skip validation of `offset`. - This means that `offset` may be beyond the end of the buffer. Defaults to `false`. - - Works as `readUInt16LE`, except buffer contents are treated as two's complement signed values. - - - - - - - - Reads a signed 16 bit integer from the buffer at the specified `offset` with big-endian format. - - Set `noAssert` to `true` to skip validation of `offset`. - This means that `offset` may be beyond the end of the buffer. Defaults to `false`. - - Works as `readUInt16BE`, except buffer contents are treated as two's complement signed values. - - - - - - - - Reads a signed 32 bit integer from the buffer at the specified `offset` with little-endian format. - - Set `noAssert` to `true` to skip validation of `offset`. - This means that `offset` may be beyond the end of the buffer. Defaults to `false`. - - Works as `readUInt32LE`, except buffer contents are treated as two's complement signed values. - - - - - - - - Reads a signed 32 bit integer from the buffer at the specified `offset` with big-endian format. - - Set `noAssert` to `true` to skip validation of `offset`. - This means that `offset` may be beyond the end of the buffer. Defaults to `false`. - - Works as `readUInt32BE`, except buffer contents are treated as two's complement signed values. - - - - - - - - Reads a 32 bit float from the buffer at the specified `offset` with little-endian format. - - Set `noAssert` to `true` to skip validation of `offset`. - This means that `offset` may be beyond the end of the buffer. Defaults to `false`. - - - - - - - - Reads a 32 bit float from the buffer at the specified `offset` with big-endian format. - - Set `noAssert` to `true` to skip validation of `offset`. - This means that `offset` may be beyond the end of the buffer. Defaults to `false`. - - - - - - - - Reads a 64 bit double from the buffer at the specified `offset` with little-endian format. - - Set `noAssert` to `true` to skip validation of `offset`. - This means that `offset` may be beyond the end of the buffer. Defaults to `false`. - - - - - - - - Reads a 64 bit double from the buffer at the specified `offset` with big-endian format. - - Set `noAssert` to `true` to skip validation of `offset`. - This means that `offset` may be beyond the end of the buffer. Defaults to `false`. - - - - - - - - - Writes `value` to the buffer at the specified `offset`. - Note, `value` must be a valid unsigned 8 bit integer. - - Set `noAssert` to `true` to skip validation of `value` and `offset`. - This means that `value` may be too large for the specific function - and `offset` may be beyond the end of the buffer leading to the values - being silently dropped. This should not be used unless you are certain - of correctness. Defaults to `false`. - - - - - - - - - Writes `value` to the buffer at the specified `offset` with little-endian format. - Note, `value` must be a valid unsigned 16 bit integer. - - Set `noAssert` to `true` to skip validation of `value` and `offset`. - This means that `value` may be too large for the specific function - and `offset` may be beyond the end of the buffer leading to the values - being silently dropped. This should not be used unless you are certain - of correctness. Defaults to `false`. - - - - - - - - - Writes `value` to the buffer at the specified `offset` with big-endian format. - Note, `value` must be a valid unsigned 16 bit integer. - - Set `noAssert` to `true` to skip validation of `value` and `offset`. - This means that `value` may be too large for the specific function - and `offset` may be beyond the end of the buffer leading to the values - being silently dropped. This should not be used unless you are certain - of correctness. Defaults to `false`. - - - - - - - - - Writes `value` to the buffer at the specified `offset` with little-endian format. - Note, `value` must be a valid unsigned 32 bit integer. - - Set `noAssert` to `true` to skip validation of `value` and `offset`. - This means that `value` may be too large for the specific function - and `offset` may be beyond the end of the buffer leading to the values - being silently dropped. This should not be used unless you are certain - of correctness. Defaults to `false`. - - - - - - - - - Writes `value` to the buffer at the specified `offset` with big-endian format. - Note, `value` must be a valid unsigned 32 bit integer. - - Set `noAssert` to `true` to skip validation of `value` and `offset`. - This means that `value` may be too large for the specific function - and `offset` may be beyond the end of the buffer leading to the values - being silently dropped. This should not be used unless you are certain - of correctness. Defaults to `false`. - - - - - - - - - Writes `value` to the buffer at the specified `offset`. - Note, `value` must be a valid signed 8 bit integer. - - Set `noAssert` to `true` to skip validation of `value` and `offset`. - This means that `value` may be too large for the specific function - and `offset` may be beyond the end of the buffer leading to the values - being silently dropped. This should not be used unless you are certain - of correctness. Defaults to `false`. - - Works as `writeUInt8`, except `value` is written out as a two's complement signed integer into buffer. - - - - - - - - - Writes `value` to the buffer at the specified `offset` with little-endian format. - Note, value must be a valid signed 16 bit integer. - - Set `noAssert` to `true` to skip validation of `value` and `offset`. - This means that `value` may be too large for the specific function - and `offset` may be beyond the end of the buffer leading to the values - being silently dropped. This should not be used unless you are certain - of correctness. Defaults to `false`. - - Works as `writeUInt16LE`, except `value` is written out as a two's complement signed integer into buffer. - - - - - - - - - Writes `value` to the buffer at the specified `offset` with big-endian format. - Note, value must be a valid signed 16 bit integer. - - Set `noAssert` to `true` to skip validation of `value` and `offset`. - This means that `value` may be too large for the specific function - and `offset` may be beyond the end of the buffer leading to the values - being silently dropped. This should not be used unless you are certain - of correctness. Defaults to `false`. - - Works as `writeUInt16BE`, except `value` is written out as a two's complement signed integer into buffer. - - - - - - - - - Writes `value` to the buffer at the specified `offset` with little-endian format. - Note, value must be a valid signed 32 bit integer. - - Set `noAssert` to `true` to skip validation of `value` and `offset`. - This means that `value` may be too large for the specific function - and `offset` may be beyond the end of the buffer leading to the values - being silently dropped. This should not be used unless you are certain - of correctness. Defaults to `false`. - - Works as `writeUInt32LE`, except `value` is written out as a two's complement signed integer into buffer. - - - - - - - - - Writes `value` to the buffer at the specified `offset` with big-endian format. - Note, value must be a valid signed 32 bit integer. - - Set `noAssert` to `true` to skip validation of `value` and `offset`. - This means that `value` may be too large for the specific function - and `offset` may be beyond the end of the buffer leading to the values - being silently dropped. This should not be used unless you are certain - of correctness. Defaults to `false`. - - Works as `writeUInt32BE`, except `value` is written out as a two's complement signed integer into buffer. - - - - - - - - - Writes `value` to the buffer at the specified `offset` with little-endian format. - Note, behavior is unspecified if `value` is not a 32 bit float. - - Set `noAssert` to `true` to skip validation of `value` and `offset`. - This means that `value` may be too large for the specific function - and `offset` may be beyond the end of the buffer leading to the values - being silently dropped. This should not be used unless you are certain - of correctness. Defaults to `false`. - - - - - - - - - Writes `value` to the buffer at the specified `offset` with big-endian format. - Note, behavior is unspecified if `value` is not a 32 bit float. - - Set `noAssert` to `true` to skip validation of `value` and `offset`. - This means that `value` may be too large for the specific function - and `offset` may be beyond the end of the buffer leading to the values - being silently dropped. This should not be used unless you are certain - of correctness. Defaults to `false`. - - - - - - - - - Writes `value` to the buffer at the specified `offset` with little-endian format. - Note, `value` must be a valid 64 bit double. - - Set `noAssert` to `true` to skip validation of `value` and `offset`. - This means that `value` may be too large for the specific function - and `offset` may be beyond the end of the buffer leading to the values - being silently dropped. This should not be used unless you are certain - of correctness. Defaults to `false`. - - - - - - - - - Writes `value` to the buffer at the specified `offset` with big-endian format. - Note, `value` must be a valid 64 bit double. - - Set `noAssert` to `true` to skip validation of `value` and `offset`. - This means that `value` may be too large for the specific function - and `offset` may be beyond the end of the buffer leading to the values - being silently dropped. This should not be used unless you are certain - of correctness. Defaults to `false`. - - - - - - - - - Fills the buffer with the specified `value`. - If the `offset` (defaults to 0) and `end` (defaults to `buffer.length`) - are not given it will fill the entire buffer. - - - - - - - - Fills the buffer with the specified `value`. - If the `offset` (defaults to 0) and `end` (defaults to `buffer.length`) - are not given it will fill the entire buffer. - - - - - - - - Returns a boolean of whether `this` and `otherBuffer` have the same bytes. - - - - - - - Returns a number indicating whether `this` comes before or after or is the same as the `otherBuffer` in sort order. - - - - - - - - Operates similar to `Array.indexOf`. - - Accepts a String, Buffer or Int. - Strings are interpreted as UTF8. - Buffers will use the entire buffer. So in order to compare a partial `Buffer` use `slice`. - Int can range from 0 to 255. - - - - - - - - Operates similar to `Array.indexOf`. - - Accepts a String, Buffer or Int. - Strings are interpreted as UTF8. - Buffers will use the entire buffer. So in order to compare a partial `Buffer` use `slice`. - Int can range from 0 to 255. - - - - - - - - Operates similar to `Array.indexOf`. - - Accepts a String, Buffer or Int. - Strings are interpreted as UTF8. - Buffers will use the entire buffer. So in order to compare a partial `Buffer` use `slice`. - Int can range from 0 to 255. - - - - - - - - - Allocates a new buffer. - - - - - - - - Allocates a new buffer. - - - - - - - Allocates a new buffer. - - - - - - - Allocates a new buffer. - - - - The Buffer class is a global type for dealing with binary data directly. It can be constructed in a variety of ways. - - It supports array access syntax to get and set the octet at index. The values refer to individual bytes, - so the legal range is between 0x00 and 0xFF hex or 0 and 255. - - "buffer" - "Buffer" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/" - - - - haxe.io.Bytes.ofString(CHARS) - - - - - - - - { complement : true } - - - - - - - - { complement : true } - - Allows to encode/decode String and bytes using Base64 encoding. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Allows to encode/decode String and bytes using a power of two base dictionary. - - - - - - - - - - - - An abstract type allowing values to be either of `T1` or `T2` type. - Supports implicit casts from/to either types. - - It is useful for interfacing with external code on dynamic platforms - such as JavaScript or Python. - - Otherwise, use of this type is discouraged. - - - - - - A special abstract type that represents "rest" function argument. - - Should be used as a type for the last argument of an extern method, - representing that arbitrary number of arguments of given type can be - passed to that method. - - - - - - The IO is set into nonblocking mode and some data cannot be read or written - An integer value is outside its allowed range - An operation on Bytes is outside of its valid range - - - Other errors - - The possible IO errors that can occur - - - - - - - - - - - - - - - - - - - - - <__unhtml set="method" line="43" static="1"> - - - - <__trace set="method" line="47" static="1"> - - - - - - - - - <__enum__ set="null"> - - - - - - - <__clear_trace set="method" line="67" static="1"> - - - - - - - - - - - - - - - - - - - - - - - - - <__string_rec set="method" line="102" static="1"> - - - - - - - - - <__enum__ set="null"> - - - - - - - "has_enum" - - - <__interfLoop set="method" line="174" static="1"> - - - - - <__instanceof set="method" line="189" static="1"> - - - - - - - - "typed_catch" - - - <__cast set="method" line="228" static="1"> - - - - - - "typed_cast" - - <__toStr expr="untyped ({ }).toString" line="233" static="1"> - - - - - - - - - - - untyped ({ }).toString - - - <__nativeClassName set="method" line="235" static="1"> - - - - - - - <__isNativeObj set="method" line="245" static="1"> - - - - <__resolveNativeClass set="method" line="250" static="1"> - - - - - - - hide - - - - - - - - "EvalError" - - - - - - - - "RangeError" - - - - - - - - "ReferenceError" - - - - - - - - "SyntaxError" - - - - - - - - "TypeError" - - - - - - - - "URIError" - - - - - - Inserts a 'debugger' statement that will make a breakpoint if a debugger is available. - - - - - - - - - "Lib.alert() is deprecated, use Browser.alert() instead" - - Display an alert message box containing the given message. - @deprecated Use Browser.alert() instead. - - - - - - - - - - - - - - - - - - Inserts a `require` expression that loads JavaScript object from - a module or file specified in the `module` argument. - - This is only supported in environments where `require` function - is available, such as Node.js or RequireJS. - - - - Returns JavaScript `undefined` value. - - Note that this is only needed in very rare cases when working with external JavaScript code. - - In Haxe, `null` is used to represent the absence of a value. - - - - - - - - `nativeThis` is the JavaScript `this`, which is semantically different - from the Haxe `this`. Use `nativeThis` only when working with external - JavaScript code. - - In Haxe, `this` is always bound to a class instance. - In JavaScript, `this` in a function can be bound to an arbitrary - variable when the function is called using `func.call(thisObj, ...)` or - `func.apply(thisObj, [...])`. - - Read more at https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/this - - - - - - - - - - - An alias of the JS "global" object. - - Concretely, it is set as the first defined value in the list of - `window`, `global`, `self`, and `this` in the top-level of the compiled output. - - - - - - - - - - - - - - - Re-throw last cathed exception, preserving original stack information. - - Calling this only makes sense inside a catch statement. - - Platform-specific JavaScript Library. Provides some platform-specific functions - for the JavaScript target. - - - - - - - - - - - - Enumeration of possible Int `options` values for `Dns.lookup`. - - - - - - cast 4 - - - - - - - - cast 6 - - - - - - - - - - - - cast 4 - - - - - - - - cast 6 - - - - - - - - - - - - If present, it should be one or more of the supported `getaddrinfo` flags. - If hints is not provided, then no flags are passed to `getaddrinfo`. - Multiple flags can be passed through hints by logically ORing their values. - - - - - The record family. If not provided, both IP v4 and v6 addresses are accepted. - - - - - When true, the callback returns all resolved addresses in an array, otherwise returns a single address. - Defaults to false. - - - Type of the `options` argument for `Dns.lookup`. - - - - - - Enumeration of possible `rrtype` value for `Dns.resolve`. - - - - - - cast "A" - - - - IPV4 addresses, default - - - - - cast "AAAA" - - - - IPV6 addresses - - - - - cast "MX" - - - - mail exchange records - - - - - cast "TXT" - - - - text records - - - - - cast "SRV" - - - - SRV records - - - - - cast "PTR" - - - - used for reverse IP lookups - - - - - cast "NS" - - - - name server records - - - - - cast "CNAME" - - - - canonical name records - - - - - cast "SOA" - - - - start of authority record - - - - - - - - - cast "A" - - - - IPV4 addresses, default - - - - - cast "AAAA" - - - - IPV6 addresses - - - - - cast "MX" - - - - mail exchange records - - - - - cast "TXT" - - - - text records - - - - - cast "SRV" - - - - SRV records - - - - - cast "PTR" - - - - used for reverse IP lookups - - - - - cast "NS" - - - - name server records - - - - - cast "CNAME" - - - - canonical name records - - - - - cast "SOA" - - - - start of authority record - - - - - - - - - Types of address data returned by `resolve` functions. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Values for error codes are listed in `Dns` class. - - Error objects returned by dns lookups are of this type - - - DNS server returned answer with no data. - DNS server claims query was misformatted. - DNS server returned general failure. - Domain name not found. - DNS server does not implement requested operation. - DNS server refused query. - Misformatted DNS query. - Misformatted domain name. - Unsupported address family. - Misformatted DNS reply. - Could not contact DNS servers. - Timeout while contacting DNS servers. - End of file. - Error reading file. - Out of memory. - Channel is being destroyed. - Misformatted string. - Illegal flags specified. - Given hostname is not numeric. - Illegal hints flags specified. - c-ares library initialization not yet performed. - Error loading iphlpapi.dll. - Could not find GetNetworkParams function. - DNS query cancelled. - Each DNS query can return one of the following error codes - - - String - "dns" - - - - - - - - - - - - - - - -
    -     - - - - - - - - Resolves a `hostname` (e.g. 'google.com') into the first found A (IPv4) or AAAA (IPv6) record. - - If `options` is not provided, then IP v4 and v6 addresses are both valid. - - The `family` can be the integer 4 or 6. Defaults to null that indicates both Ip v4 and v6 address family. - - The `callback` has arguments (err, address, family). - The `address` argument is a string representation of a IP v4 or v6 address. - The `family` argument is either the integer 4 or 6 and denotes the family - of address (not necessarily the value initially passed to lookup). - - With the `all` option set, the arguments change to (err, addresses), with addresses being an array of objects - with the properties `address` and `family`. - - Keep in mind that `err.code` will be set to 'ENOENT' not only when the hostname does not exist but - also when the lookup fails in other ways such as no available file descriptors. - - `lookup` doesn't necessarily have anything to do with the DNS protocol. It's only an operating system facility - that can associate name with addresses, and vice versa. - - - - - - - - - - - - - - Resolves a `hostname` (e.g. 'google.com') into the first found A (IPv4) or AAAA (IPv6) record. - - If `options` is not provided, then IP v4 and v6 addresses are both valid. - - The `family` can be the integer 4 or 6. Defaults to null that indicates both Ip v4 and v6 address family. - - The `callback` has arguments (err, address, family). - The `address` argument is a string representation of a IP v4 or v6 address. - The `family` argument is either the integer 4 or 6 and denotes the family - of address (not necessarily the value initially passed to lookup). - - With the `all` option set, the arguments change to (err, addresses), with addresses being an array of objects - with the properties `address` and `family`. - - Keep in mind that `err.code` will be set to 'ENOENT' not only when the hostname does not exist but - also when the lookup fails in other ways such as no available file descriptors. - - `lookup` doesn't necessarily have anything to do with the DNS protocol. It's only an operating system facility - that can associate name with addresses, and vice versa. - - - - - A flag passed in the `hints` argument of `lookup` method. - - Returned address types are determined by the types of addresses supported by the current system. - For example, IPv4 addresses are only returned if the current system has at least one IPv4 address configured. - Loopback addresses are not considered. - - - - A flag passed in the `hints` argument of `lookup` method. - - If the IPv6 family was specified, but no IPv6 addresses were found, then return IPv4 mapped IPv6 addresses. - Note that it is not supported on some operating systems (e.g FreeBSD 10.1). - - - - - - - - - - - - - - Resolves the given `address` and `port` into a hostname and service using `getnameinfo`. - - The `callback` has arguments (err, hostname, service). - The `hostname` and `service` arguments are strings (e.g. 'localhost' and 'http' respectively). - - On error, `err` is an Error object, where `err.code` is the error code. - - - - - - - - - - - - - Resolves a `hostname` (e.g. 'google.com') into an array of the record types specified by `rrtype`. - - The `callback` has arguments (err, addresses). - The type of each item in `addresses` is determined by the record type, - and described in the documentation for the corresponding lookup methods below. - - On error, `err` is an Error object, where `err.code` is the error code. - - - - - - - - - - - Resolves a `hostname` (e.g. 'google.com') into an array of the record types specified by `rrtype`. - - The `callback` has arguments (err, addresses). - The type of each item in `addresses` is determined by the record type, - and described in the documentation for the corresponding lookup methods below. - - On error, `err` is an Error object, where `err.code` is the error code. - - - - - - - - - - - - - The same as `resolve`, but only for IPv4 queries (A records). - `addresses` is an array of IPv4 addresses (e.g. ['74.125.79.104', '74.125.79.105', '74.125.79.106']). - - - - - - - - - - - - The same as `resolve4` except for IPv6 queries (an AAAA query). - - - - - - - - - - - - The same as `resolve`, but only for mail exchange queries (MX records). - `addresses` is an array of MX records, each with a priority - and an exchange attribute (e.g. [{'priority': 10, 'exchange': 'mx.example.com'},...]). - - - - - - - - - - - - The same as `resolve`, but only for text queries (TXT records). - `addresses` is a 2-d array of the text records available for hostname (e.g., [ ['v=spf1 ip4:0.0.0.0 ', '~all' ] ]). - Each sub-array contains TXT chunks of one record. Depending on the use case, the could be either joined together - or treated separately. - - - - - - - - - - - - The same as `resolve`, but only for service records (SRV records). - `addresses` is an array of the SRV records available for `hostname`. - Properties of SRV records are priority, weight, port, and name - (e.g., [{'priority': 10, 'weight': 5, 'port': 21223, 'name': 'service.example.com'}, ...]). - - - - - - - - - - - - The same as `resolve`, but only for start of authority record queries (SOA record). - - `addresses` is an object with the following structure: - { - nsname: 'ns.example.com', - hostmaster: 'root.example.com', - serial: 2013101809, - refresh: 10000, - retry: 2400, - expire: 604800, - minttl: 3600 - } - - - - - - - - - - - - The same as `resolve`, but only for name server records (NS records). - `addresses` is an array of the name server records available for hostname (e.g., ['ns1.example.com', 'ns2.example.com']). - - - - - - - - - - - - The same as `resolve`, but only for canonical name records (CNAME records). - `addresses` is an array of the canonical name records available for hostname (e.g., ['bar.example.com']). - - - - - - - - - - - - Reverse resolves an `ip` address to an array of hostnames. - The `callback` has arguments (err, hostname). - - - - Returns an array of IP addresses as strings that are currently being used for resolution. - - - - - - - Given an array of IP addresses as strings, set them as the servers to use for resolving. - - If you specify a port with the address it will be stripped, as the underlying library doesn't support that. - - This will throw if you pass invalid input. - - This module contains functions that belong to two different categories: - - 1) Functions that use the underlying operating system facilities to perform name resolution, - and that do not necessarily do any network communication. This category contains only one function: `lookup`. - Developers looking to perform name resolution in the same way that other applications on the same operating - system behave should use `lookup`. - - 2) Functions that connect to an actual DNS server to perform name resolution, - and that always use the network to perform DNS queries. This category contains all functions in the dns module but `lookup`. - These functions do not use the same set of configuration files than what `lookup` uses. For instance, - they do not use the configuration from /etc/hosts. These functions should be used by developers who do not want - to use the underlying operating system's facilities for name resolution, and instead want to always perform DNS queries. - "dns" - - - - - - - - - - Object containing the number of milliseconds the CPU/core spent in: user, nice, sys, idle, and irq - - - - - - CPUTime data. - - - - MHz Speed - - - - CPU Model. E.g. 'Intel(R) Core(TM) i7 CPU 860 @ 2.80GHz' - - - Object containing information about each CPU/core installed: model, speed (in MHz), and times - - - - Objects containing information about network interface addresses. - - - - - Whether this address is internal. - - - - IP address family (e.g. IPv4, IPv6). - -
    - - IP address (format depends on family). -
    -     - - - - - - - - - cast "BE" - - - - - - - - cast "LE" - - - - - - - - - - - - cast "BE" - - - - - - - - cast "LE" - - - - - - - - - - A constant defining the appropriate End-of-line marker for the operating system. - - - - Returns the operating system's default directory for temp files. - - - - Returns the endianness of the CPU. Possible values are "BE" or "LE". - - - - Returns the hostname of the operating system. - - - - Returns the operating system name. - - - - Returns the operating system platform. - - - - Returns the operating system CPU architecture. - - - - Returns the operating system release. - - - - Returns the system uptime in seconds. - - - - Returns an array containing the 1, 5, and 15 minute load averages. - - The load average is a measure of system activity, calculated by the operating system and expressed as a fractional number. - As a rule of thumb, the load average should ideally be less than the number of logical CPUs in the system. - - The load average is a very UNIX-y concept; there is no real equivalent on Windows platforms. - That is why this function always returns [0, 0, 0] on Windows. - - - - Returns the total amount of system memory in bytes. - - - - Returns the amount of free system memory in bytes. - - - - Returns an array of objects containing information about each CPU/core installed: model, speed (in MHz), - and times (an object containing the number of milliseconds the CPU/core spent in: user, nice, sys, idle, and irq). - - - - Get a list of network interfaces: - - Provides a few basic operating-system related utility functions. - "os" - - - - - Enumeration of events emitted by all `EventEmitter` instances. - - - - - - - - - - cast "newListener" - - - - This event is emitted any time someone adds a new listener. - - Listener arguments: - event - The event name - listener - The event handler function - - It is unspecified if listener is in the list returned by emitter.listeners(event). - - - - - - - - - cast "removeListener" - - - - This event is emitted any time someone removes a listener. - - Listener arguments: - event - The event name - listener - The event handler function - - It is unspecified if listener is in the list returned by emitter.listeners(event). - - - - - - - - - - - - - cast "newListener" - - - - This event is emitted any time someone adds a new listener. - - Listener arguments: - event - The event name - listener - The event handler function - - It is unspecified if listener is in the list returned by emitter.listeners(event). - - - - - - - - - cast "removeListener" - - - - This event is emitted any time someone removes a listener. - - Listener arguments: - event - The event name - listener - The event handler function - - It is unspecified if listener is in the list returned by emitter.listeners(event). - - - - - - - - Abstract type for events. Its type parameter is a signature - of a listener for a concrete event. - - - - - - - - - - - - - - - - - - - - - - - - - Only valid with `Fs.lstat`. - - - - Objects returned from `Fs.stat`, `Fs.lstat` and `Fs.fstat` and their synchronous counterparts are of this type. - - - - - - - - - - - - - cast "open" - - - - Emitted when the `WriteStream`'s file is opened. - - Listener arguments: - fd - file descriptor used by the `WriteStream`. - - - - - - - - - - - - cast "open" - - - - Emitted when the `WriteStream`'s file is opened. - - Listener arguments: - fd - file descriptor used by the `WriteStream`. - - - - - - Writable file stream. - - - - - - Enumeration of possible HTTP methods as described in - http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html - - - - - - cast "GET" - - - - - - - - cast "POST" - - - - - - - - cast "HEAD" - - - - - - - - cast "OPTIONS" - - - - - - - - cast "PUT" - - - - - - - - cast "DELETE" - - - - - - - - cast "TRACE" - - - - - - - - cast "CONNECT" - - - - - - - - - - - - cast "GET" - - - - - - - - cast "POST" - - - - - - - - cast "HEAD" - - - - - - - - cast "OPTIONS" - - - - - - - - cast "PUT" - - - - - - - - cast "DELETE" - - - - - - - - cast "TRACE" - - - - - - - - cast "CONNECT" - - - - - - - - - - Enumeration of events emitted by the `ServerResponse` objects in addition to its parent class events. - - - - - - cast "close" - - - - Indicates that the underlying connection was terminated before `end` was called or able to flush. - - - - - cast "finish" - - - - Emitted when the response has been sent. More specifically, this event is emitted when - the last segment of the response headers and body have been handed off to the operating system - for transmission over the network. It does not imply that the client has received anything yet. - - After this event, no more events will be emitted on the response object. - - - - - - - - - cast "close" - - - - Indicates that the underlying connection was terminated before `end` was called or able to flush. - - - - - cast "finish" - - - - Emitted when the response has been sent. More specifically, this event is emitted when - the last segment of the response headers and body have been handed off to the operating system - for transmission over the network. It does not imply that the client has received anything yet. - - After this event, no more events will be emitted on the response object. - - - - - - - Enumeration of events for `Socket` objects. - - - - - - - - - - - cast "lookup" - - - - Emitted after resolving the hostname but before connecting. - Not applicable to UNIX sockets. - - - - - cast "connect" - - - - Emitted when a socket connection is successfully established. See `Socket.connect`. - - - - - - - - - - - cast "data" - - - - Emitted when data is received. - The argument data will be a `Buffer` or `String`. - Encoding of data is set by `Socket.setEncoding`. - - Note that the data will be lost if there is no listener when a Socket emits a 'data' event. - - - - - cast "end" - - - - Emitted when the other end of the socket sends a FIN packet. - - By default (allowHalfOpen == false) the socket will destroy its file descriptor once - it has written out its pending write queue. However, by setting allowHalfOpen == true - the socket will not automatically `end` its side allowing the user to write arbitrary amounts of data, - with the caveat that the user is required to `end` their side now. - - - - - cast "timeout" - - - - Emitted if the socket times out from inactivity. - This is only to notify that the socket has been idle - The user must manually close the connection. - See also: `Socket.setTimeout` - - - - - cast "drain" - - - - Emitted when the write buffer becomes empty. Can be used to throttle uploads. - See also: the return values of `Socket.write` - - - - - - - - cast "error" - - - - Emitted when an error occurs. The 'close' event will be called directly following this event. - - - - - - - - cast "close" - - - - Emitted once the socket is fully closed. - The argument `had_error` is a boolean which says if the socket was closed due to a transmission error. - - Listener arguments: - had_error - true if the socket had a transmission error - - - - - - - - - - - - - - cast "lookup" - - - - Emitted after resolving the hostname but before connecting. - Not applicable to UNIX sockets. - - - - - cast "connect" - - - - Emitted when a socket connection is successfully established. See `Socket.connect`. - - - - - - - - - - - cast "data" - - - - Emitted when data is received. - The argument data will be a `Buffer` or `String`. - Encoding of data is set by `Socket.setEncoding`. - - Note that the data will be lost if there is no listener when a Socket emits a 'data' event. - - - - - cast "end" - - - - Emitted when the other end of the socket sends a FIN packet. - - By default (allowHalfOpen == false) the socket will destroy its file descriptor once - it has written out its pending write queue. However, by setting allowHalfOpen == true - the socket will not automatically `end` its side allowing the user to write arbitrary amounts of data, - with the caveat that the user is required to `end` their side now. - - - - - cast "timeout" - - - - Emitted if the socket times out from inactivity. - This is only to notify that the socket has been idle - The user must manually close the connection. - See also: `Socket.setTimeout` - - - - - cast "drain" - - - - Emitted when the write buffer becomes empty. Can be used to throttle uploads. - See also: the return values of `Socket.write` - - - - - - - - cast "error" - - - - Emitted when an error occurs. The 'close' event will be called directly following this event. - - - - - - - - cast "close" - - - - Emitted once the socket is fully closed. - The argument `had_error` is a boolean which says if the socket was closed due to a transmission error. - - Listener arguments: - had_error - true if the socket had a transmission error - - - - - - - If true, then the socket won't automatically send a FIN packet - when the other end of the socket sends a FIN packet. - - The socket becomes non-readable, but still writable. You should call the `end` method explicitly. - See `end` event for more information. - - Default: false - - - - - - - allow writes on this socket (NOTE: Works only when `fd` is passed) - - - - - allow reads on this socket (NOTE: Works only when `fd` is passed) - - - - - allows you to specify the existing file descriptor of socket. - - - - - If true, then the socket won't automatically send a FIN packet - when the other end of the socket sends a FIN packet. - - The socket becomes non-readable, but still writable. You should call the `end` method explicitly. - See `end` event for more information. - - Default: false - - - Options for creating new `Socket` object. - - - - - - Port the client should connect to - - - - - - - - - - Custom lookup function. Defaults to `Dns.lookup`. - - - - - Local port to bind to for network connections. - - - - - Local interface to bind to for network connections. - - - - - Host the client should connect to. - Defaults to 'localhost'. - - - - - Version of IP stack. Defaults to 4. - - - Options for the `Socket.connect` method (TCP version). - - - - - Path the client should connect to - - Options for the `Socket.connect` method (Local domain socket version). - - - - - - Connection port. - - - - IP Family. - -
    - - IP Address. -
    -     - Bound address, the address family name and port of the socket as reported by the operating system. -     - - - - Enumeration of possible socket family values. - - - - - - cast "IPv4" - - - - - - - - cast "IPv6" - - - - - - - - - - - - cast "IPv4" - - - - - - - - cast "IPv6" - - - - - - - - - - - - - - - - This method writes some data to the underlying system, - and calls the supplied callback once the data has been fully handled. - - The return value indicates if you should continue writing right now. If the data had to be buffered internally, - then it will return `false`. Otherwise, it will return `true`. - - This return value is strictly advisory. You MAY continue to write, even if it returns `false`. - However, writes will be buffered in memory, so it is best not to do this excessively. - Instead, wait for the `drain` event before writing more data. - - - - - - - - This method writes some data to the underlying system, - and calls the supplied callback once the data has been fully handled. - - The return value indicates if you should continue writing right now. If the data had to be buffered internally, - then it will return `false`. Otherwise, it will return `true`. - - This return value is strictly advisory. You MAY continue to write, even if it returns `false`. - However, writes will be buffered in memory, so it is best not to do this excessively. - Instead, wait for the `drain` event before writing more data. - - - - - - - - This method writes some data to the underlying system, - and calls the supplied callback once the data has been fully handled. - - The return value indicates if you should continue writing right now. If the data had to be buffered internally, - then it will return `false`. Otherwise, it will return `true`. - - This return value is strictly advisory. You MAY continue to write, even if it returns `false`. - However, writes will be buffered in memory, so it is best not to do this excessively. - Instead, wait for the `drain` event before writing more data. - - - - - - - - - - - Call this method when no more data will be written to the stream. - If supplied, the callback is attached as a listener on the `finish` event. - - Calling `write()` after calling `end()` will raise an error. - - - - - - - Call this method when no more data will be written to the stream. - If supplied, the callback is attached as a listener on the `finish` event. - - Calling `write()` after calling `end()` will raise an error. - - - - - - - - Call this method when no more data will be written to the stream. - If supplied, the callback is attached as a listener on the `finish` event. - - Calling `write()` after calling `end()` will raise an error. - - - - - - Terminal write streams (i.e. process.stdout) have this property set to true. - It is false for any other write streams. - - <_write set="method"> - - - - - - - - - - <_write set="method"> - - - - - - - - - - - - - - Duplex streams are streams that implement both the `Readable` and `Writable` interfaces. - - Use relevant event enumeration types from `Readable` and `Writable` modules. - - Examples of `Duplex` streams include: - - tcp sockets - - zlib streams - - crypto streams - - "stream" - "Duplex" - - - - - - - - - - - - - - Opens the connection for a given socket. - - If `port` and `host` are given, then the socket will be opened as a TCP socket, - if `host` is omitted, localhost will be assumed. - If a `path` is given, the socket will be opened as a unix socket to that path. - - Normally this method is not needed, as `Net.createConnection` opens the socket. - Use this only if you are implementing a custom `Socket`. - - This function is asynchronous. When the 'connect' event is emitted the socket is established. - If there is a problem connecting, the 'connect' event will not be emitted, - the 'error' event will be emitted with the exception - - The `connectListener` parameter will be added as an listener for the 'connect' event. - - - - - - - - Opens the connection for a given socket. - - If `port` and `host` are given, then the socket will be opened as a TCP socket, - if `host` is omitted, localhost will be assumed. - If a `path` is given, the socket will be opened as a unix socket to that path. - - Normally this method is not needed, as `Net.createConnection` opens the socket. - Use this only if you are implementing a custom `Socket`. - - This function is asynchronous. When the 'connect' event is emitted the socket is established. - If there is a problem connecting, the 'connect' event will not be emitted, - the 'error' event will be emitted with the exception - - The `connectListener` parameter will be added as an listener for the 'connect' event. - - - - - - - - Opens the connection for a given socket. - - If `port` and `host` are given, then the socket will be opened as a TCP socket, - if `host` is omitted, localhost will be assumed. - If a `path` is given, the socket will be opened as a unix socket to that path. - - Normally this method is not needed, as `Net.createConnection` opens the socket. - Use this only if you are implementing a custom `Socket`. - - This function is asynchronous. When the 'connect' event is emitted the socket is established. - If there is a problem connecting, the 'connect' event will not be emitted, - the 'error' event will be emitted with the exception - - The `connectListener` parameter will be added as an listener for the 'connect' event. - - - - - - - - - Opens the connection for a given socket. - - If `port` and `host` are given, then the socket will be opened as a TCP socket, - if `host` is omitted, localhost will be assumed. - If a `path` is given, the socket will be opened as a unix socket to that path. - - Normally this method is not needed, as `Net.createConnection` opens the socket. - Use this only if you are implementing a custom `Socket`. - - This function is asynchronous. When the 'connect' event is emitted the socket is established. - If there is a problem connecting, the 'connect' event will not be emitted, - the 'error' event will be emitted with the exception - - The `connectListener` parameter will be added as an listener for the 'connect' event. - - - - - - `Socket` has the property that `socket.write` always works. This is to help users get up and running quickly. - The computer cannot always keep up with the amount of data that is written to a socket - the network connection - simply might be too slow. Node will internally queue up the data written to a socket and send it out over the - wire when it is possible. (Internally it is polling on the socket's file descriptor for being writable). - - The consequence of this internal buffering is that memory may grow. This property shows the number of characters - currently buffered to be written. (Number of characters is approximately equal to the number of bytes to be written, - but the buffer may contain strings, and the strings are lazily encoded, so the exact number of bytes is not known.) - - Users who experience large or growing `bufferSize` should attempt to "throttle" the data flows - in their program with `pause` and `resume`. - - - - Ensures that no more I/O activity happens on this socket. Only necessary in case of errors (parse error or so). - - - - - - - - Sets the socket to timeout after `timeout` milliseconds of inactivity on the socket. - By default `Socket` do not have a timeout. - - When an idle timeout is triggered the socket will receive a 'timeout' event but the connection will not be severed. - The user must manually `end` or `destroy` the socket. - - If `timeout` is 0, then the existing idle timeout is disabled. - - The optional `callback` parameter will be added as a one time listener for the 'timeout' event. - - - - - - - Disables the Nagle algorithm. - By default TCP connections use the Nagle algorithm, they buffer data before sending it off. - Setting true for `noDelay` will immediately fire off data each time `write` is called. - `noDelay` defaults to true. - - - - - - - - Enable/disable keep-alive functionality, and optionally set the initial delay - before the first keepalive probe is sent on an idle socket. - - `enable` defaults to false. - - Set `initialDelay` (in milliseconds) to set the delay between the last data packet received and - the first keepalive probe. - - Setting 0 for `initialDelay` will leave the value unchanged from the default (or previous) setting. - Defaults to 0. - - - - - - Enable/disable keep-alive functionality, and optionally set the initial delay - before the first keepalive probe is sent on an idle socket. - - `enable` defaults to false. - - Set `initialDelay` (in milliseconds) to set the delay between the last data packet received and - the first keepalive probe. - - Setting 0 for `initialDelay` will leave the value unchanged from the default (or previous) setting. - Defaults to 0. - - -
    - - Returns the bound address, the address family name and port of the socket as reported by the operating system. -
    - - - Calling `unref` on a socket will allow the program to exit if this is the only active socket in the event system. - If the socket is already `unref`d calling `unref` again will have no effect. - - - - Opposite of `unref`, calling `ref` on a previously `unref`d socket will not let the program exit - if it's the only socket left (the default behavior). - If the socket is `ref`d calling `ref` again will have no effect. - - - - The string representation of the remote IP address. - For example, '74.125.127.100' or '2001:4860:a005::68'. - - - - The string representation of the remote IP family. - 'IPv4' or 'IPv6'. - - - - The numeric representation of the remote port. For example, 80 or 21. - - - - The string representation of the local IP address the remote client is connecting on. - For example, if you are listening on '0.0.0.0' and the client connects on '192.168.1.1', - the value would be '192.168.1.1'. - - - - The numeric representation of the local port. For example, 80 or 21. - - - - The amount of received bytes. - - - - The amount of bytes sent. - - - - Always true for TLSSocket instances. - - May be used to distinguish TLS sockets from regular ones. - - - - - - - Construct a new socket object. - - - "net" - "Socket" - -     - - - - - - - - - - - - - - - - - - - - - - - - Options for `Duplex` private constructor. - For stream implementors only, see node.js API documentation - - - - - - Enumeration of events emitted by the `Readable` class. - - - - - - cast "readable" - - - - When a chunk of data can be read from the stream, it will emit a `readable` event. - - In some cases, listening for a `readable` event will cause some data to be read into - the internal buffer from the underlying system, if it hadn't already. - - Once the internal buffer is drained, a 'readable' event will fire again when more data is available. - - - - - - - - - - - cast "data" - - - - If you attach a 'data' event listener, then it will switch the stream into flowing mode, - and data will be passed to your handler as soon as it is available. - - If you just want to get all the data out of the stream as fast as possible, this is the best way to do so. - - - - - cast "end" - - - - This event fires when there will be no more data to read. - - Note that the 'end' event will not fire unless the data is completely consumed. - This can be done by switching into flowing mode, or by calling 'read' repeatedly until you get to the end. - - - - - cast "close" - - - - Emitted when the underlying resource (for example, the backing file descriptor) has been closed. - - Not all streams will emit this. - - - - - - - - cast "error" - - - - Emitted if there was an error receiving data. - - - - - - - - - cast "readable" - - - - When a chunk of data can be read from the stream, it will emit a `readable` event. - - In some cases, listening for a `readable` event will cause some data to be read into - the internal buffer from the underlying system, if it hadn't already. - - Once the internal buffer is drained, a 'readable' event will fire again when more data is available. - - - - - - - - - - - cast "data" - - - - If you attach a 'data' event listener, then it will switch the stream into flowing mode, - and data will be passed to your handler as soon as it is available. - - If you just want to get all the data out of the stream as fast as possible, this is the best way to do so. - - - - - cast "end" - - - - This event fires when there will be no more data to read. - - Note that the 'end' event will not fire unless the data is completely consumed. - This can be done by switching into flowing mode, or by calling 'read' repeatedly until you get to the end. - - - - - cast "close" - - - - Emitted when the underlying resource (for example, the backing file descriptor) has been closed. - - Not all streams will emit this. - - - - - - - - cast "error" - - - - Emitted if there was an error receiving data. - - - - - - - - - - - - - - - - - - - Options for `Readable` private constructor. - For stream implementors only, see node.js API documentation - - - - - Enumeration for `Writable` class events. - - - - - - cast "drain" - - - - If a `writable.write(chunk)` call returns `false`, then the `drain` event will indicate - when it is appropriate to begin writing more data to the stream. - - - - - cast "finish" - - - - When the `end()` method has been called, and all data has been flushed to the underlying system, this event is emitted. - - - - - - - - cast "pipe" - - - - Lister arguments: - src - source stream that is piping to `this` writable - - This is emitted whenever the `pipe()` method is called on a readable stream, - adding `this` writable to its set of destinations. - - - - - - - - cast "unpipe" - - - - Listener arguments: - src - source stream that unpiped `this` writable - - This is emitted whenever the `unpipe()` method is called on a readable stream, - removing `this` writable from its set of destinations. - - - - - - - - cast "error" - - - - Emitted if there was an error when writing or piping data. - - - - - - - - - cast "drain" - - - - If a `writable.write(chunk)` call returns `false`, then the `drain` event will indicate - when it is appropriate to begin writing more data to the stream. - - - - - cast "finish" - - - - When the `end()` method has been called, and all data has been flushed to the underlying system, this event is emitted. - - - - - - - - cast "pipe" - - - - Lister arguments: - src - source stream that is piping to `this` writable - - This is emitted whenever the `pipe()` method is called on a readable stream, - adding `this` writable to its set of destinations. - - - - - - - - cast "unpipe" - - - - Listener arguments: - src - source stream that unpiped `this` writable - - This is emitted whenever the `unpipe()` method is called on a readable stream, - removing `this` writable from its set of destinations. - - - - - - - - cast "error" - - - - Emitted if there was an error when writing or piping data. - - - - - - - - - - - - - - - - - - - Options for `Writable` private constructor. - For stream implementors only, see node.js API documentation - - - - - "Basic" - - - - "authorization" - - - - "WWW-Authenticate" - - - - "realm" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - "authorization" - - - - "Bearer" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - "body-parser" - - - - - - - - - - "connect-busboy" - - - - - - - - - - "compression" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - "cookie-parser" - - - - - - - - - - - "cookie-session" - - - - - - - - - - "cors" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - "express-brute" - - - - - - - "express-force-ssl" - - - - - - - - - - - - - - "serve-favicon" -     - - - - - - - - - "express-jwt" - - - - - - - - - - - - - - - - - - - - "morgan" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - "on-finished" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - "passport" - - - - - - - - - - - - - - - - "express-slash" - - - - - - - "express-uncapitalize" - - - - - - - - - - "express-unless" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file