Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Strict Violation using this keyword and revealing module pattern

Having trouble getting the following to pass jslint/jshint

/*jshint strict: true */ var myModule = (function() {     "use strict";      var privVar = true,         pubVar = false;      function privFn() {         return this.test; // -> Strict violation.     }      function pubFn() {         this.test = 'public'; // -> Strict violation.         privFn.call(this); // -> Strict violation.     }      return {         pubVar: pubVar,         pubFn: pubFn     };  }());  myModule.pubFn(); 

I understand it's being caused by the use of this in a function declaration, but I read something Crockford wrote and he said the violation is meant to prevent global variable pollution - but the only global variable here is the one I'm explicitly defining... myModule. Everything else is held in the immediate function scope, and I should be able to use this to refer to the module.

Any ideas how I can get this pattern to pass?

Update: if I use a function expression instead of a declaration, this seems to work, ie

var pubFn = function () { ... 

I'm not a fan of this format though, prefer to have the function name and named params closer and the declaration looks/feels cleaner. I honestly don't see why this is throwing the violation - there's no reason for it in this pattern.

like image 241
Matty F Avatar asked Jun 10 '11 01:06

Matty F


People also ask

What is the revealing module pattern?

The Revealing Module pattern is a design pattern for Javascript applications that elegantly solves this problem. The central principle of the Revealing Module pattern is that all functionality and variables should be hidden unless deliberately exposed.

Is a design pattern which let you organise your JavaScript code in modules and gives better code structure?

Revealing Module Pattern is JavaScript's design pattern that is available for users to actually organize JavaScript's codes in modules which actually gives better code structure and helps in making things either private or public to users.

When to use JavaScript module pattern?

The Module Pattern is one of the important patterns in JavaScript. It is a commonly used Design Pattern which is used to wrap a set of variables and functions together in a single scope. It is used to define objects and specify the variables and the functions that can be accessed from outside the scope of the function.


1 Answers

JSHint has an option called validthis, which:

[...] suppresses warnings about possible strict violations when the code is running in strict mode and you use this in a non-constructor function [...], when you are positive that your use of this is valid in strict mode.

Use it in the function that JSHint is complaining about, which in your case, would look like this:

function privFn() {     /*jshint validthis: true */     return this.test; // -> No Strict violation! }  function pubFn() {     /*jshint validthis: true */     this.test = 'public'; // -> No Strict violation!     privFn.call(this); // -> No Strict violation! } 

It might seem like a pain to have to specify that in each function where it applies, but if you set the option at the top of your module function, you may hide genuine strict mode violations from yourself.

like image 149
markrian Avatar answered Sep 29 '22 17:09

markrian