mobx/refguide/computed-decorator.html at new-docs · JavaScriptExpert/mobx

History

1078 lines (592 loc) · 39.6 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

<!DOCTYPE HTML>

<head>

<title>(@)computed | MobX</title>

</head>

<body>

</div>

Introduction

</a>

</li>

1. Introduction to MobX

1.1.

The Gist of MobX

</a>

</li>

1.2.

Concepts & Principles

</a>

</li>

</ul>

</li>

2.

API overview

</a>

</li>

3. Making things observable

3.1.

observable

</a>

</li>

3.2.

@observable

</a>

</li>

3.3.

objects

</a>

</li>

3.4.

arrays

</a>

</li>

3.5.

maps

</a>

</li>

3.6.

boxed values

</a>

</li>

3.7.

decorators

</a>

</li>

</ul>

</li>

4. Reacting to observables

4.1.

(@)computed

</a>

</li>

4.2.

autorun

</a>

</li>

4.3.

when

</a>

</li>

4.4.

reaction

</a>

</li>

4.5.

(@)observer

</a>

</li>

4.6.

Understanding what MobX reacts to

</a>

</li>

</ul>

</li>

5. Changing observables

5.1.

action

</a>

</li>

5.2.

async actions & flows

</a>

</li>

5.3.

Object api

</a>

</li>

</ul>

</li>

6. Utility functions

6.1.

toJS

</a>

</li>

6.2.

extendObservable

</a>

</li>

6.3.

createAtom

</a>

</li>

6.4.

intercept & observe

</a>

</li>

6.5.

mobxUtils.fromPromise

</a>

</li>

6.6.

mobxUtis.fromResource

</a>

</li>

6.7.

mobxUtils.toStream

</a>

</li>

6.8.

mobxUtils.fromStream

</a>

</li>

6.9.

mobxUtils.now

</a>

</li>

6.10.

mobxUtils.keepAlive

</a>

</li>

6.11.

mobxUtils.createTransformer

</a>

</li>

6.12.

mobxUtils.expr

</a>

</li>

</ul>

</li>

7.

Blogs, videos, related projects

</a>

</li>

8. Tips & Tricks

8.1.

Frequently Asked Questions

</a>

</li>

8.2.

Common Pitfalls & Best Practices

</a>

</li>

8.3.

How to (not) use decorator syntax

</a>

</li>

8.4.

Using trace for debugging

</a>

</li>

8.5.

Defining data stores

</a>

</li>

8.6.

Optimizing React components

</a>

</li>

8.7.

DevTools

</a>

</li>

8.8.

spy

</a>

</li>

</ul>

</li>

9.

Donate

</a>

</li>

<li>

Published with GitBook

</a>

</li>

</ul>

</nav>

</div>

</a>

</div>

</div>

<button type="button" data-font="0" class="button">Serif</button>

</div>

<button type="button" id="color-theme-preview-0" class="button size-3" data-theme="0">White</button>

<button type="button" id="color-theme-preview-1" class="button size-3" data-theme="1">Sepia</button>

<button type="button" id="color-theme-preview-2" class="button size-3" data-theme="2">Night</button>

</div>

</a>

</div>

Share on Twitter

</button>

Share on Google

</button>

Share on Facebook

</button>

Share on Weibo

</button>

Share on Instapaper

</button>

</div>

<h1>

</h1>

</div>

<html><head></head><body><a id="edit-link" href="https://github.com/mobxjs/mobx/tree/gh-pages/docs/refguide/computed-decorator.md" class="btn fa fa-edit pull-left">  Edit This Page</a><h1 id="-computed"><a name="-computed" class="plugin-anchor" href="#-computed"></a>(@)computed</h1>

<a style="color: white; background:green;padding:5px;margin:5px;border-radius:2px" href="https://egghead.io/lessons/javascript-derive-computed-values-and-manage-side-effects-with-mobx-reactions" target="_blank">egghead.io lesson 3: computed values</a>

Computed values are values that can be derived from the existing state or other computed values.

Conceptually, they are very similar to formulas in spreadsheets.

Computed values can't be underestimated, as they help you to make your actual modifiable state as small as possible.

Besides that they are highly optimized, so use them wherever possible.

Don't confuse <code>computed</code> with <code>autorun</code>. They are both reactively invoked expressions,

but use <code>@computed</code> if you want to reactively produce a value that can be used by other observers and

<code>autorun</code> if you don't want to produce a new value but rather want to achieve an effect.

For example imperative side effects like logging, making network requests etc.

Computed values are automatically derived from your state if any value that affects them changes.

Computed values can be optimized away in many cases by MobX as they are assumed to be pure.

For example, a computed property won't re-run if none of the data used in the previous computation changed.

Nor will a computed property re-run if is not in use by some other computed property or reaction.

In such cases it will be suspended.

This automatic suspension is very convenient. If a computed value is no longer observed, for example the UI in which it was used no longer exists, MobX can automatically garbage collect it. This differs from <code>autorun</code>'s values where you must dispose of them yourself.

It sometimes confuses people new to MobX, that if you create a computed property but don't use it anywhere in a reaction, it will not cache its value and recompute more often than seems necessary.

However, in real life situations this is by far the best default, and you can always forcefully keep a computed value awake if you need to, by using either <a href="observe.html"><code>observe</code></a> or <a href="https://github.com/mobxjs/mobx-utils#keepalive" target="_blank"><code>keepAlive</code></a>.

Note that <code>computed</code> properties are not enumerable. Nor can they be overwritten in an inheritance chain.

<h2 id="-computed"><a name="-computed" class="plugin-anchor" href="#-computed"></a><code>@computed</code></h2>

If you have <a href="../best/decorators.html">decorators enabled</a> you can use the <code>@computed</code> decorator on any getter of a class property to declaratively created computed properties.

<pre><code class="lang-javascript">import {observable, computed} from "mobx";

class OrderLine {

@observable price = 0;

@observable amount = 1;

constructor(price) {

this.price = price;

}

@computed get total() {

return this.price * this.amount;

}

</code></pre>

Otherwise, use <code>decorate</code> to introduce them:

<pre><code class="lang-javascript">import {decorate, observable, computed} from "mobx";

class OrderLine {

price = 0;

amount = 1;

constructor(price) {

this.price = price;

}

get total() {

return this.price * this.amount;

}

decorate(OrderLine, {

price: observable,

amount: observable,

total: computed

})

</code></pre>

Both <code>observable.object</code> and <code>extendObservable</code> will automatically infer getter properties to be computed properties, so the followin suffices:

<pre><code class="lang-javascript">const orderLine = observable.object({

price: 0,

amount: 1,

get total() {

return this.price * this.amount

}

})

</code></pre>

<h2 id="setters-for-computed-values"><a name="setters-for-computed-values" class="plugin-anchor" href="#setters-for-computed-values"></a>Setters for computed values</h2>

It is possible to define a setter for computed values as well. Note that these setters cannot be used to alter the value of the computed property directly,

but they can be used as 'inverse' of the derivation. For example:

<pre><code class="lang-javascript">const orderLine = observable.object({

price: 0,

amount: 1,

get total() {

return this.price * this.amount

set total(total) {

this.price = total / this.amount // infer price from total

}

})

</code></pre>

And similarly

<pre><code class="lang-javascript">class Foo {

@observable length = 2;

@computed get squared() {

return this.length * this.length;

}

set squared(value) { //this is automatically an action, no annotation necessary

this.length = Math.sqrt(value);

}

</code></pre>

Note: always define the setter after the getter, some TypeScript versions are known to declare two properties with the same name otherwise.

<h2 id="-computed-expression-as-function"><a name="-computed-expression-as-function" class="plugin-anchor" href="#-computed-expression-as-function"></a><code>computed(expression)</code> as function</h2>

<code>computed</code> can also be invoked directly as function.

Just like <code>observable.box(primitive value)</code> creates a stand-alone observable.

Use <code>.get()</code> on the returned object to get the current value of the computation, or <code>.observe(callback)</code> to observe its changes.

This form of <code>computed</code> is not used very often, but in some cases where you need to pass a "boxed" computed value around it might prove useful.

Example:

<pre><code class="lang-javascript">import {observable, computed} from "mobx";

var name = observable("John");

var upperCaseName = computed(() =>

name.get().toUpperCase()

);

var disposer = upperCaseName.observe(change => console.log(change.newValue));

name.set("Dave");

// prints: 'DAVE'

</code></pre>

<h2 id="options-for-computed"><a name="options-for-computed" class="plugin-anchor" href="#options-for-computed"></a>Options for <code>computed</code></h2>

When using <code>computed</code> as modifier or as box, it accepts a second options argument with the following optional arguments:

<ul>

<li><code>name</code>: String, the debug name used in spy and the MobX devtools</li>

<li><code>context</code>: The <code>this</code> that should be used in the provided expression</li>

<li><code>set</code>: The setter function to be used. Without setter it is not possible to assign new values to a computed value. If the second argument passed to <code>computed</code> is a function, this is assumed to be a setter.</li>

<li><code>equals</code>: By default <code>comparer.default</code>. This acts as a comparison function for comparing the previous value with the next value. If this function considers the previous and next values to be equal, then observers will not be re-evaluated. This is useful when working with structural data, and types from other libraries. For example, a computed <a href="https://momentjs.com/" target="_blank">moment</a> instance could use <code>(a, b) => a.isSame(b)</code>. <code>comparer.deep</code> comes in handy if you want to use structural comparison to determine whether the new value is different from the previous value (and as a result notify observers).</li>

<li><code>requiresReaction</code>: It is recommended to set this one to <code>true</code> on very expensive computed values. If you try to read it's value, but the value is not being tracked by some observer (in which case MobX won't cache the value), it will cause the computed to throw, instead of doing an expensive re-evalution.</li>

</ul>

<h2 id="-computed-struct-for-structural-comparison"><a name="-computed-struct-for-structural-comparison" class="plugin-anchor" href="#-computed-struct-for-structural-comparison"></a><code>@computed.struct</code> for structural comparison</h2>

View remainder of file in raw view

Navigation Menu

Uh oh!

Uh oh!

FilesExpand file tree

computed-decorator.html

Latest commit

History

computed-decorator.html

File metadata and controls